REST API SDK for SMS
\
Clx
Xms
Api

\Clx\Xms\ApiGroupResult

This class holds the result of a group fetch operation.

This may be used either standalone or as an element of a paged result.

Summary

Methods
Properties
Constants
getGroupId()
setGroupId()
getName()
setName()
getSize()
setSize()
getChildGroups()
setChildGroups()
getAutoUpdate()
setAutoUpdate()
getCreatedAt()
setCreatedAt()
getModifiedAt()
setModifiedAt()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getGroupId()

getGroupId() : string

Get the unique group identifier.

Returns

string —

group identifier

setGroupId()

setGroupId(string  $groupId) : void

Set the unique group identifier.

Parameters

string $groupId

group identifier

getName()

getName() : string

Get the group name.

Returns

string —

group name

setName()

setName(string  $name) : void

Set the group name.

Parameters

string $name

group name

getSize()

getSize() : integer

Get the number of members of this group.

Returns

integer —

number of group members

setSize()

setSize(integer  $size) : void

Set the number of members of this group.

Parameters

integer $size

number of group members

getChildGroups()

getChildGroups() : array<mixed,string>

Get a list of the groups that in turn belong to this group.

Returns

array<mixed,string> —

group identifiers of the child groups

setChildGroups()

setChildGroups(array<mixed,string>  $childGroups) : void

Set the list of groups that in turn belong to this group.

Parameters

array<mixed,string> $childGroups

group identifiers of the child groups

getAutoUpdate()

getAutoUpdate() : \Clx\Xms\Api\GroupAutoUpdate|null

Get description of how this group should be auto updated.

If no auto updating should be performed for the group then this returns null.

Returns

\Clx\Xms\Api\GroupAutoUpdate|null —

the auto update definition

setAutoUpdate()

setAutoUpdate(\Clx\Xms\Api\GroupAutoUpdate|null  $autoUpdate) : void

Set description of how this group should be auto updated.

If no auto updating should be performed for the group then this may be set to null.

Parameters

\Clx\Xms\Api\GroupAutoUpdate|null $autoUpdate

the auto update definition

getCreatedAt()

getCreatedAt() : \DateTime

Get the time when this group was created.

Returns

\DateTime —

the time of creation

setCreatedAt()

setCreatedAt(\DateTime  $createdAt) : void

Set the time when this group was created.

Parameters

\DateTime $createdAt

the time of creation

getModifiedAt()

getModifiedAt() : \DateTime

Get the time when this group was last modified.

Returns

\DateTime —

the time of last modification

setModifiedAt()

setModifiedAt(\DateTime  $modifiedAt) : void

Set the time when this group was last modified.

Parameters

\DateTime $modifiedAt

the time of last modification