Documentation

Google_Service_Directory_User 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.
$addresses  : mixed
$agreedToTerms  : mixed
$aliases  : mixed
$archived  : mixed
$changePasswordAtNextLogin  : mixed
$creationTime  : mixed
$customerId  : mixed
$customSchemas  : mixed
$deletionTime  : mixed
$emails  : mixed
$etag  : mixed
$externalIds  : mixed
$gender  : mixed
$hashFunction  : mixed
$id  : mixed
$ims  : mixed
$includeInGlobalAddressList  : mixed
$ipWhitelisted  : mixed
$isAdmin  : mixed
$isDelegatedAdmin  : mixed
$isEnforcedIn2Sv  : mixed
$isEnrolledIn2Sv  : mixed
$isMailboxSetup  : mixed
$keywords  : mixed
$kind  : mixed
$languages  : mixed
$lastLoginTime  : mixed
$locations  : mixed
$nonEditableAliases  : mixed
$notes  : mixed
$organizations  : mixed
$orgUnitPath  : mixed
$password  : mixed
$phones  : mixed
$posixAccounts  : mixed
$primaryEmail  : mixed
$recoveryEmail  : mixed
$recoveryPhone  : mixed
$relations  : mixed
$sshPublicKeys  : mixed
$suspended  : mixed
$suspensionReason  : mixed
$thumbnailPhotoEtag  : mixed
$thumbnailPhotoUrl  : mixed
$websites  : mixed
$collection_key  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$nameDataType  : mixed
$nameType  : mixed
$processed  : 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
getAddresses()  : mixed
getAgreedToTerms()  : mixed
getAliases()  : mixed
getArchived()  : mixed
getChangePasswordAtNextLogin()  : mixed
getCreationTime()  : mixed
getCustomerId()  : mixed
getCustomSchemas()  : mixed
getDeletionTime()  : mixed
getEmails()  : mixed
getEtag()  : mixed
getExternalIds()  : mixed
getGender()  : mixed
getHashFunction()  : mixed
getId()  : mixed
getIms()  : mixed
getIncludeInGlobalAddressList()  : mixed
getIpWhitelisted()  : mixed
getIsAdmin()  : mixed
getIsDelegatedAdmin()  : mixed
getIsEnforcedIn2Sv()  : mixed
getIsEnrolledIn2Sv()  : mixed
getIsMailboxSetup()  : mixed
getKeywords()  : mixed
getKind()  : mixed
getLanguages()  : mixed
getLastLoginTime()  : mixed
getLocations()  : mixed
getName()  : Google_Service_Directory_UserName
getNonEditableAliases()  : mixed
getNotes()  : mixed
getOrganizations()  : mixed
getOrgUnitPath()  : mixed
getPassword()  : mixed
getPhones()  : mixed
getPosixAccounts()  : mixed
getPrimaryEmail()  : mixed
getRecoveryEmail()  : mixed
getRecoveryPhone()  : mixed
getRelations()  : mixed
getSshPublicKeys()  : mixed
getSuspended()  : mixed
getSuspensionReason()  : mixed
getThumbnailPhotoEtag()  : mixed
getThumbnailPhotoUrl()  : mixed
getWebsites()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAddresses()  : mixed
setAgreedToTerms()  : mixed
setAliases()  : mixed
setArchived()  : mixed
setChangePasswordAtNextLogin()  : mixed
setCreationTime()  : mixed
setCustomerId()  : mixed
setCustomSchemas()  : mixed
setDeletionTime()  : mixed
setEmails()  : mixed
setEtag()  : mixed
setExternalIds()  : mixed
setGender()  : mixed
setHashFunction()  : mixed
setId()  : mixed
setIms()  : mixed
setIncludeInGlobalAddressList()  : mixed
setIpWhitelisted()  : mixed
setIsAdmin()  : mixed
setIsDelegatedAdmin()  : mixed
setIsEnforcedIn2Sv()  : mixed
setIsEnrolledIn2Sv()  : mixed
setIsMailboxSetup()  : mixed
setKeywords()  : mixed
setKind()  : mixed
setLanguages()  : mixed
setLastLoginTime()  : mixed
setLocations()  : mixed
setName()  : mixed
setNonEditableAliases()  : mixed
setNotes()  : mixed
setOrganizations()  : mixed
setOrgUnitPath()  : mixed
setPassword()  : mixed
setPhones()  : mixed
setPosixAccounts()  : mixed
setPrimaryEmail()  : mixed
setRecoveryEmail()  : mixed
setRecoveryPhone()  : mixed
setRelations()  : mixed
setSshPublicKeys()  : mixed
setSuspended()  : mixed
setSuspensionReason()  : mixed
setThumbnailPhotoEtag()  : mixed
setThumbnailPhotoUrl()  : mixed
setWebsites()  : 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

$addresses

public mixed $addresses

$agreedToTerms

public mixed $agreedToTerms

$aliases

public mixed $aliases

$archived

public mixed $archived

$changePasswordAtNextLogin

public mixed $changePasswordAtNextLogin

$creationTime

public mixed $creationTime

$customerId

public mixed $customerId

$customSchemas

public mixed $customSchemas

$deletionTime

public mixed $deletionTime

$emails

public mixed $emails

$etag

public mixed $etag

$externalIds

public mixed $externalIds

$gender

public mixed $gender

$hashFunction

public mixed $hashFunction

$includeInGlobalAddressList

public mixed $includeInGlobalAddressList

$ipWhitelisted

public mixed $ipWhitelisted

$isAdmin

public mixed $isAdmin

$isDelegatedAdmin

public mixed $isDelegatedAdmin

$isEnforcedIn2Sv

public mixed $isEnforcedIn2Sv

$isEnrolledIn2Sv

public mixed $isEnrolledIn2Sv

$isMailboxSetup

public mixed $isMailboxSetup

$keywords

public mixed $keywords

$kind

public mixed $kind

$languages

public mixed $languages

$lastLoginTime

public mixed $lastLoginTime

$locations

public mixed $locations

$nonEditableAliases

public mixed $nonEditableAliases

$notes

public mixed $notes

$organizations

public mixed $organizations

$orgUnitPath

public mixed $orgUnitPath

$password

public mixed $password

$phones

public mixed $phones

$posixAccounts

public mixed $posixAccounts

$primaryEmail

public mixed $primaryEmail

$recoveryEmail

public mixed $recoveryEmail

$recoveryPhone

public mixed $recoveryPhone

$relations

public mixed $relations

$sshPublicKeys

public mixed $sshPublicKeys

$suspended

public mixed $suspended

$suspensionReason

public mixed $suspensionReason

$thumbnailPhotoEtag

public mixed $thumbnailPhotoEtag

$thumbnailPhotoUrl

public mixed $thumbnailPhotoUrl

$websites

public mixed $websites

$collection_key

protected mixed $collection_key = 'nonEditableAliases'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$nameDataType

protected mixed $nameDataType = ''

$nameType

protected mixed $nameType = 'Google_Service_Directory_UserName'

$processed

protected mixed $processed = array()

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 —

getAddresses()

public getAddresses() : mixed
Return values
mixed —

getAgreedToTerms()

public getAgreedToTerms() : mixed
Return values
mixed —

getAliases()

public getAliases() : mixed
Return values
mixed —

getArchived()

public getArchived() : mixed
Return values
mixed —

getChangePasswordAtNextLogin()

public getChangePasswordAtNextLogin() : mixed
Return values
mixed —

getCreationTime()

public getCreationTime() : mixed
Return values
mixed —

getCustomerId()

public getCustomerId() : mixed
Return values
mixed —

getCustomSchemas()

public getCustomSchemas() : mixed
Return values
mixed —

getDeletionTime()

public getDeletionTime() : mixed
Return values
mixed —

getEmails()

public getEmails() : mixed
Return values
mixed —

getEtag()

public getEtag() : mixed
Return values
mixed —

getExternalIds()

public getExternalIds() : mixed
Return values
mixed —

getGender()

public getGender() : mixed
Return values
mixed —

getHashFunction()

public getHashFunction() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getIms()

public getIms() : mixed
Return values
mixed —

getIncludeInGlobalAddressList()

public getIncludeInGlobalAddressList() : mixed
Return values
mixed —

getIpWhitelisted()

public getIpWhitelisted() : mixed
Return values
mixed —

getIsAdmin()

public getIsAdmin() : mixed
Return values
mixed —

getIsDelegatedAdmin()

public getIsDelegatedAdmin() : mixed
Return values
mixed —

getIsEnforcedIn2Sv()

public getIsEnforcedIn2Sv() : mixed
Return values
mixed —

getIsEnrolledIn2Sv()

public getIsEnrolledIn2Sv() : mixed
Return values
mixed —

getIsMailboxSetup()

public getIsMailboxSetup() : mixed
Return values
mixed —

getKeywords()

public getKeywords() : mixed
Return values
mixed —

getKind()

public getKind() : mixed
Return values
mixed —

getLanguages()

public getLanguages() : mixed
Return values
mixed —

getLastLoginTime()

public getLastLoginTime() : mixed
Return values
mixed —

getLocations()

public getLocations() : mixed
Return values
mixed —

getNonEditableAliases()

public getNonEditableAliases() : mixed
Return values
mixed —

getNotes()

public getNotes() : mixed
Return values
mixed —

getOrganizations()

public getOrganizations() : mixed
Return values
mixed —

getOrgUnitPath()

public getOrgUnitPath() : mixed
Return values
mixed —

getPassword()

public getPassword() : mixed
Return values
mixed —

getPhones()

public getPhones() : mixed
Return values
mixed —

getPosixAccounts()

public getPosixAccounts() : mixed
Return values
mixed —

getPrimaryEmail()

public getPrimaryEmail() : mixed
Return values
mixed —

getRecoveryEmail()

public getRecoveryEmail() : mixed
Return values
mixed —

getRecoveryPhone()

public getRecoveryPhone() : mixed
Return values
mixed —

getRelations()

public getRelations() : mixed
Return values
mixed —

getSshPublicKeys()

public getSshPublicKeys() : mixed
Return values
mixed —

getSuspended()

public getSuspended() : mixed
Return values
mixed —

getSuspensionReason()

public getSuspensionReason() : mixed
Return values
mixed —

getThumbnailPhotoEtag()

public getThumbnailPhotoEtag() : mixed
Return values
mixed —

getThumbnailPhotoUrl()

public getThumbnailPhotoUrl() : mixed
Return values
mixed —

getWebsites()

public getWebsites() : 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 —

setAddresses()

public setAddresses(mixed $addresses) : mixed
Parameters
$addresses : mixed
Return values
mixed —

setAgreedToTerms()

public setAgreedToTerms(mixed $agreedToTerms) : mixed
Parameters
$agreedToTerms : mixed
Return values
mixed —

setAliases()

public setAliases(mixed $aliases) : mixed
Parameters
$aliases : mixed
Return values
mixed —

setArchived()

public setArchived(mixed $archived) : mixed
Parameters
$archived : mixed
Return values
mixed —

setChangePasswordAtNextLogin()

public setChangePasswordAtNextLogin(mixed $changePasswordAtNextLogin) : mixed
Parameters
$changePasswordAtNextLogin : mixed
Return values
mixed —

setCreationTime()

public setCreationTime(mixed $creationTime) : mixed
Parameters
$creationTime : mixed
Return values
mixed —

setCustomerId()

public setCustomerId(mixed $customerId) : mixed
Parameters
$customerId : mixed
Return values
mixed —

setCustomSchemas()

public setCustomSchemas(mixed $customSchemas) : mixed
Parameters
$customSchemas : mixed
Return values
mixed —

setDeletionTime()

public setDeletionTime(mixed $deletionTime) : mixed
Parameters
$deletionTime : mixed
Return values
mixed —

setEmails()

public setEmails(mixed $emails) : mixed
Parameters
$emails : mixed
Return values
mixed —

setEtag()

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

setExternalIds()

public setExternalIds(mixed $externalIds) : mixed
Parameters
$externalIds : mixed
Return values
mixed —

setGender()

public setGender(mixed $gender) : mixed
Parameters
$gender : mixed
Return values
mixed —

setHashFunction()

public setHashFunction(mixed $hashFunction) : mixed
Parameters
$hashFunction : mixed
Return values
mixed —

setId()

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

setIms()

public setIms(mixed $ims) : mixed
Parameters
$ims : mixed
Return values
mixed —

setIncludeInGlobalAddressList()

public setIncludeInGlobalAddressList(mixed $includeInGlobalAddressList) : mixed
Parameters
$includeInGlobalAddressList : mixed
Return values
mixed —

setIpWhitelisted()

public setIpWhitelisted(mixed $ipWhitelisted) : mixed
Parameters
$ipWhitelisted : mixed
Return values
mixed —

setIsAdmin()

public setIsAdmin(mixed $isAdmin) : mixed
Parameters
$isAdmin : mixed
Return values
mixed —

setIsDelegatedAdmin()

public setIsDelegatedAdmin(mixed $isDelegatedAdmin) : mixed
Parameters
$isDelegatedAdmin : mixed
Return values
mixed —

setIsEnforcedIn2Sv()

public setIsEnforcedIn2Sv(mixed $isEnforcedIn2Sv) : mixed
Parameters
$isEnforcedIn2Sv : mixed
Return values
mixed —

setIsEnrolledIn2Sv()

public setIsEnrolledIn2Sv(mixed $isEnrolledIn2Sv) : mixed
Parameters
$isEnrolledIn2Sv : mixed
Return values
mixed —

setIsMailboxSetup()

public setIsMailboxSetup(mixed $isMailboxSetup) : mixed
Parameters
$isMailboxSetup : mixed
Return values
mixed —

setKeywords()

public setKeywords(mixed $keywords) : mixed
Parameters
$keywords : mixed
Return values
mixed —

setKind()

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

setLanguages()

public setLanguages(mixed $languages) : mixed
Parameters
$languages : mixed
Return values
mixed —

setLastLoginTime()

public setLastLoginTime(mixed $lastLoginTime) : mixed
Parameters
$lastLoginTime : mixed
Return values
mixed —

setLocations()

public setLocations(mixed $locations) : mixed
Parameters
$locations : mixed
Return values
mixed —

setNonEditableAliases()

public setNonEditableAliases(mixed $nonEditableAliases) : mixed
Parameters
$nonEditableAliases : mixed
Return values
mixed —

setNotes()

public setNotes(mixed $notes) : mixed
Parameters
$notes : mixed
Return values
mixed —

setOrganizations()

public setOrganizations(mixed $organizations) : mixed
Parameters
$organizations : mixed
Return values
mixed —

setOrgUnitPath()

public setOrgUnitPath(mixed $orgUnitPath) : mixed
Parameters
$orgUnitPath : mixed
Return values
mixed —

setPassword()

public setPassword(mixed $password) : mixed
Parameters
$password : mixed
Return values
mixed —

setPhones()

public setPhones(mixed $phones) : mixed
Parameters
$phones : mixed
Return values
mixed —

setPosixAccounts()

public setPosixAccounts(mixed $posixAccounts) : mixed
Parameters
$posixAccounts : mixed
Return values
mixed —

setPrimaryEmail()

public setPrimaryEmail(mixed $primaryEmail) : mixed
Parameters
$primaryEmail : mixed
Return values
mixed —

setRecoveryEmail()

public setRecoveryEmail(mixed $recoveryEmail) : mixed
Parameters
$recoveryEmail : mixed
Return values
mixed —

setRecoveryPhone()

public setRecoveryPhone(mixed $recoveryPhone) : mixed
Parameters
$recoveryPhone : mixed
Return values
mixed —

setRelations()

public setRelations(mixed $relations) : mixed
Parameters
$relations : mixed
Return values
mixed —

setSshPublicKeys()

public setSshPublicKeys(mixed $sshPublicKeys) : mixed
Parameters
$sshPublicKeys : mixed
Return values
mixed —

setSuspended()

public setSuspended(mixed $suspended) : mixed
Parameters
$suspended : mixed
Return values
mixed —

setSuspensionReason()

public setSuspensionReason(mixed $suspensionReason) : mixed
Parameters
$suspensionReason : mixed
Return values
mixed —

setThumbnailPhotoEtag()

public setThumbnailPhotoEtag(mixed $thumbnailPhotoEtag) : mixed
Parameters
$thumbnailPhotoEtag : mixed
Return values
mixed —

setThumbnailPhotoUrl()

public setThumbnailPhotoUrl(mixed $thumbnailPhotoUrl) : mixed
Parameters
$thumbnailPhotoUrl : mixed
Return values
mixed —

setWebsites()

public setWebsites(mixed $websites) : mixed
Parameters
$websites : 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