Documentation

Google_Service_Calendar_Event extends Google_Collection
in package

Extension to the regular Google_Model that automatically exposes the items array for iteration, so you can just iterate over the object rather than a reference inside.

Table of Contents

NULL_VALUE  = "{}gapi-php-null"
If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.
$anyoneCanAddSelf  : mixed
$attendeesOmitted  : mixed
$colorId  : mixed
$created  : mixed
$description  : mixed
$endTimeUnspecified  : mixed
$etag  : mixed
$guestsCanInviteOthers  : mixed
$guestsCanModify  : mixed
$guestsCanSeeOtherGuests  : mixed
$hangoutLink  : mixed
$htmlLink  : mixed
$iCalUID  : mixed
$id  : mixed
$kind  : mixed
$location  : mixed
$locked  : mixed
$privateCopy  : mixed
$recurrence  : mixed
$recurringEventId  : mixed
$sequence  : mixed
$status  : mixed
$summary  : mixed
$transparency  : mixed
$updated  : mixed
$visibility  : mixed
$attachmentsDataType  : mixed
$attachmentsType  : mixed
$attendeesDataType  : mixed
$attendeesType  : mixed
$collection_key  : mixed
$conferenceDataDataType  : mixed
$conferenceDataType  : mixed
$creatorDataType  : mixed
$creatorType  : mixed
$endDataType  : mixed
$endType  : mixed
$extendedPropertiesDataType  : mixed
$extendedPropertiesType  : mixed
$gadgetDataType  : mixed
$gadgetType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$organizerDataType  : mixed
$organizerType  : mixed
$originalStartTimeDataType  : mixed
$originalStartTimeType  : mixed
$processed  : mixed
$remindersDataType  : mixed
$remindersType  : mixed
$sourceDataType  : mixed
$sourceType  : mixed
$startDataType  : mixed
$startType  : mixed
__construct()  : mixed
Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.
__get()  : mixed
Getter that handles passthrough access to the data array, and lazy object creation.
__isset()  : mixed
__unset()  : mixed
assertIsArray()  : mixed
Verify if $obj is an array.
count()  : mixed
current()  : mixed
getAnyoneCanAddSelf()  : mixed
getAttachments()  : Google_Service_Calendar_EventAttachment
getAttendees()  : Google_Service_Calendar_EventAttendee
getAttendeesOmitted()  : mixed
getColorId()  : mixed
getConferenceData()  : Google_Service_Calendar_ConferenceData
getCreated()  : mixed
getCreator()  : Google_Service_Calendar_EventCreator
getDescription()  : mixed
getEnd()  : Google_Service_Calendar_EventDateTime
getEndTimeUnspecified()  : mixed
getEtag()  : mixed
getExtendedProperties()  : Google_Service_Calendar_EventExtendedProperties
getGadget()  : Google_Service_Calendar_EventGadget
getGuestsCanInviteOthers()  : mixed
getGuestsCanModify()  : mixed
getGuestsCanSeeOtherGuests()  : mixed
getHangoutLink()  : mixed
getHtmlLink()  : mixed
getICalUID()  : mixed
getId()  : mixed
getKind()  : mixed
getLocation()  : mixed
getLocked()  : mixed
getOrganizer()  : Google_Service_Calendar_EventOrganizer
getOriginalStartTime()  : Google_Service_Calendar_EventDateTime
getPrivateCopy()  : mixed
getRecurrence()  : mixed
getRecurringEventId()  : mixed
getReminders()  : Google_Service_Calendar_EventReminders
getSequence()  : mixed
getSource()  : Google_Service_Calendar_EventSource
getStart()  : Google_Service_Calendar_EventDateTime
getStatus()  : mixed
getSummary()  : mixed
getTransparency()  : mixed
getUpdated()  : mixed
getVisibility()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAnyoneCanAddSelf()  : mixed
setAttachments()  : mixed
setAttendees()  : mixed
setAttendeesOmitted()  : mixed
setColorId()  : mixed
setConferenceData()  : mixed
setCreated()  : mixed
setCreator()  : mixed
setDescription()  : mixed
setEnd()  : mixed
setEndTimeUnspecified()  : mixed
setEtag()  : mixed
setExtendedProperties()  : mixed
setGadget()  : mixed
setGuestsCanInviteOthers()  : mixed
setGuestsCanModify()  : mixed
setGuestsCanSeeOtherGuests()  : mixed
setHangoutLink()  : mixed
setHtmlLink()  : mixed
setICalUID()  : mixed
setId()  : mixed
setKind()  : mixed
setLocation()  : mixed
setLocked()  : mixed
setOrganizer()  : mixed
setOriginalStartTime()  : mixed
setPrivateCopy()  : mixed
setRecurrence()  : mixed
setRecurringEventId()  : mixed
setReminders()  : mixed
setSequence()  : mixed
setSource()  : mixed
setStart()  : mixed
setStatus()  : mixed
setSummary()  : mixed
setTransparency()  : mixed
setUpdated()  : mixed
setVisibility()  : mixed
toSimpleObject()  : mixed
Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.
valid()  : mixed
dataType()  : mixed
gapiInit()  : mixed
Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.
isAssociativeArray()  : bool
Returns true only if the array is associative.
keyType()  : mixed
mapTypes()  : void
Initialize this object's properties from an array.
camelCase()  : string
Convert a string to camelCase
coerceType()  : mixed
getMappedName()  : mixed
If there is an internal name mapping, use that.
getSimpleValue()  : mixed
Handle different types of values, primarily other objects and map and array data types.
nullPlaceholderCheck()  : mixed
Check whether the value is the null placeholder and return true null.

Constants

NULL_VALUE

If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.

public mixed NULL_VALUE = "{}gapi-php-null"

Properties

$anyoneCanAddSelf

public mixed $anyoneCanAddSelf

$attendeesOmitted

public mixed $attendeesOmitted

$colorId

public mixed $colorId

$created

public mixed $created

$description

public mixed $description

$endTimeUnspecified

public mixed $endTimeUnspecified

$guestsCanInviteOthers

public mixed $guestsCanInviteOthers

$guestsCanModify

public mixed $guestsCanModify

$guestsCanSeeOtherGuests

public mixed $guestsCanSeeOtherGuests
public mixed $hangoutLink
public mixed $htmlLink

$iCalUID

public mixed $iCalUID

$location

public mixed $location

$locked

public mixed $locked

$privateCopy

public mixed $privateCopy

$recurrence

public mixed $recurrence

$recurringEventId

public mixed $recurringEventId

$sequence

public mixed $sequence

$status

public mixed $status

$summary

public mixed $summary

$transparency

public mixed $transparency

$updated

public mixed $updated

$visibility

public mixed $visibility

$attachmentsDataType

protected mixed $attachmentsDataType = 'array'

$attachmentsType

protected mixed $attachmentsType = 'Google_Service_Calendar_EventAttachment'

$attendeesDataType

protected mixed $attendeesDataType = 'array'

$attendeesType

protected mixed $attendeesType = 'Google_Service_Calendar_EventAttendee'

$collection_key

protected mixed $collection_key = 'recurrence'

$conferenceDataDataType

protected mixed $conferenceDataDataType = ''

$conferenceDataType

protected mixed $conferenceDataType = 'Google_Service_Calendar_ConferenceData'

$creatorDataType

protected mixed $creatorDataType = ''

$creatorType

protected mixed $creatorType = 'Google_Service_Calendar_EventCreator'

$endDataType

protected mixed $endDataType = ''

$endType

protected mixed $endType = 'Google_Service_Calendar_EventDateTime'

$extendedPropertiesDataType

protected mixed $extendedPropertiesDataType = ''

$extendedPropertiesType

protected mixed $extendedPropertiesType = 'Google_Service_Calendar_EventExtendedProperties'

$gadgetDataType

protected mixed $gadgetDataType = ''

$gadgetType

protected mixed $gadgetType = 'Google_Service_Calendar_EventGadget'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$organizerDataType

protected mixed $organizerDataType = ''

$organizerType

protected mixed $organizerType = 'Google_Service_Calendar_EventOrganizer'

$originalStartTimeDataType

protected mixed $originalStartTimeDataType = ''

$originalStartTimeType

protected mixed $originalStartTimeType = 'Google_Service_Calendar_EventDateTime'

$processed

protected mixed $processed = array()

$remindersDataType

protected mixed $remindersDataType = ''

$remindersType

protected mixed $remindersType = 'Google_Service_Calendar_EventReminders'

$sourceDataType

protected mixed $sourceDataType = ''

$sourceType

protected mixed $sourceType = 'Google_Service_Calendar_EventSource'

$startDataType

protected mixed $startDataType = ''

$startType

protected mixed $startType = 'Google_Service_Calendar_EventDateTime'

Methods

__construct()

Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.

public final __construct() : mixed
Return values
mixed

__get()

Getter that handles passthrough access to the data array, and lazy object creation.

public __get(string $key) : mixed
Parameters
$key : string

Property name.

Return values
mixed

The value if any, or null.

__isset()

public __isset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

__unset()

public __unset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

assertIsArray()

Verify if $obj is an array.

public assertIsArray(array<string|int, mixed> $obj, string $method) : mixed
Parameters
$obj : array<string|int, mixed>

Items that should be validated.

$method : string

Method expecting an array as an argument.

Tags
throws
Google_Exception

Thrown if $obj isn't an array.

Return values
mixed

count()

public count() : mixed
Return values
mixed

current()

public current() : mixed
Return values
mixed

getAnyoneCanAddSelf()

public getAnyoneCanAddSelf() : mixed
Return values
mixed

getAttendeesOmitted()

public getAttendeesOmitted() : mixed
Return values
mixed

getColorId()

public getColorId() : mixed
Return values
mixed

getCreated()

public getCreated() : mixed
Return values
mixed

getDescription()

public getDescription() : mixed
Return values
mixed

getEndTimeUnspecified()

public getEndTimeUnspecified() : mixed
Return values
mixed

getEtag()

public getEtag() : mixed
Return values
mixed

getGuestsCanInviteOthers()

public getGuestsCanInviteOthers() : mixed
Return values
mixed

getGuestsCanModify()

public getGuestsCanModify() : mixed
Return values
mixed

getGuestsCanSeeOtherGuests()

public getGuestsCanSeeOtherGuests() : mixed
Return values
mixed
public getHangoutLink() : mixed
Return values
mixed
public getHtmlLink() : mixed
Return values
mixed

getICalUID()

public getICalUID() : mixed
Return values
mixed

getId()

public getId() : mixed
Return values
mixed

getKind()

public getKind() : mixed
Return values
mixed

getLocation()

public getLocation() : mixed
Return values
mixed

getLocked()

public getLocked() : mixed
Return values
mixed

getPrivateCopy()

public getPrivateCopy() : mixed
Return values
mixed

getRecurrence()

public getRecurrence() : mixed
Return values
mixed

getRecurringEventId()

public getRecurringEventId() : mixed
Return values
mixed

getSequence()

public getSequence() : mixed
Return values
mixed

getStatus()

public getStatus() : mixed
Return values
mixed

getSummary()

public getSummary() : mixed
Return values
mixed

getTransparency()

public getTransparency() : mixed
Return values
mixed

getUpdated()

public getUpdated() : mixed
Return values
mixed

getVisibility()

public getVisibility() : mixed
Return values
mixed

key()

public key() : mixed
Return values
mixed

next()

public next() : mixed
Return values
mixed

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

rewind()

public rewind() : mixed
Return values
mixed

setAnyoneCanAddSelf()

public setAnyoneCanAddSelf(mixed $anyoneCanAddSelf) : mixed
Parameters
$anyoneCanAddSelf : mixed
Return values
mixed

setAttachments()

public setAttachments(mixed $attachments) : mixed
Parameters
$attachments : mixed
Return values
mixed

setAttendees()

public setAttendees(mixed $attendees) : mixed
Parameters
$attendees : mixed
Return values
mixed

setAttendeesOmitted()

public setAttendeesOmitted(mixed $attendeesOmitted) : mixed
Parameters
$attendeesOmitted : mixed
Return values
mixed

setColorId()

public setColorId(mixed $colorId) : mixed
Parameters
$colorId : mixed
Return values
mixed

setCreated()

public setCreated(mixed $created) : mixed
Parameters
$created : mixed
Return values
mixed

setDescription()

public setDescription(mixed $description) : mixed
Parameters
$description : mixed
Return values
mixed

setEndTimeUnspecified()

public setEndTimeUnspecified(mixed $endTimeUnspecified) : mixed
Parameters
$endTimeUnspecified : mixed
Return values
mixed

setEtag()

public setEtag(mixed $etag) : mixed
Parameters
$etag : mixed
Return values
mixed

setGuestsCanInviteOthers()

public setGuestsCanInviteOthers(mixed $guestsCanInviteOthers) : mixed
Parameters
$guestsCanInviteOthers : mixed
Return values
mixed

setGuestsCanModify()

public setGuestsCanModify(mixed $guestsCanModify) : mixed
Parameters
$guestsCanModify : mixed
Return values
mixed

setGuestsCanSeeOtherGuests()

public setGuestsCanSeeOtherGuests(mixed $guestsCanSeeOtherGuests) : mixed
Parameters
$guestsCanSeeOtherGuests : mixed
Return values
mixed
public setHangoutLink(mixed $hangoutLink) : mixed
Parameters
$hangoutLink : mixed
Return values
mixed
public setHtmlLink(mixed $htmlLink) : mixed
Parameters
$htmlLink : mixed
Return values
mixed

setICalUID()

public setICalUID(mixed $iCalUID) : mixed
Parameters
$iCalUID : mixed
Return values
mixed

setId()

public setId(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed

setKind()

public setKind(mixed $kind) : mixed
Parameters
$kind : mixed
Return values
mixed

setLocation()

public setLocation(mixed $location) : mixed
Parameters
$location : mixed
Return values
mixed

setLocked()

public setLocked(mixed $locked) : mixed
Parameters
$locked : mixed
Return values
mixed

setPrivateCopy()

public setPrivateCopy(mixed $privateCopy) : mixed
Parameters
$privateCopy : mixed
Return values
mixed

setRecurrence()

public setRecurrence(mixed $recurrence) : mixed
Parameters
$recurrence : mixed
Return values
mixed

setRecurringEventId()

public setRecurringEventId(mixed $recurringEventId) : mixed
Parameters
$recurringEventId : mixed
Return values
mixed

setSequence()

public setSequence(mixed $sequence) : mixed
Parameters
$sequence : mixed
Return values
mixed

setStatus()

public setStatus(mixed $status) : mixed
Parameters
$status : mixed
Return values
mixed

setSummary()

public setSummary(mixed $summary) : mixed
Parameters
$summary : mixed
Return values
mixed

setTransparency()

public setTransparency(mixed $transparency) : mixed
Parameters
$transparency : mixed
Return values
mixed

setUpdated()

public setUpdated(mixed $updated) : mixed
Parameters
$updated : mixed
Return values
mixed

setVisibility()

public setVisibility(mixed $visibility) : mixed
Parameters
$visibility : mixed
Return values
mixed

toSimpleObject()

Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.

public toSimpleObject() : mixed
Return values
mixed

valid()

public valid() : mixed
Return values
mixed

dataType()

protected dataType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

gapiInit()

Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.

protected gapiInit() : mixed
Return values
mixed

isAssociativeArray()

Returns true only if the array is associative.

protected isAssociativeArray(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>
Return values
bool

True if the array is associative.

keyType()

protected keyType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

mapTypes()

Initialize this object's properties from an array.

protected mapTypes(array<string|int, mixed> $array) : void
Parameters
$array : array<string|int, mixed>

Used to seed this object's properties.

Return values
void

camelCase()

Convert a string to camelCase

private camelCase(string $value) : string
Parameters
$value : string
Return values
string

coerceType()

private coerceType(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

getMappedName()

If there is an internal name mapping, use that.

private getMappedName(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

getSimpleValue()

Handle different types of values, primarily other objects and map and array data types.

private getSimpleValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

nullPlaceholderCheck()

Check whether the value is the null placeholder and return true null.

private nullPlaceholderCheck(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

Search results