\Clx\Xms\ApiGroupCreate

A description of the fields necessary to create a group.

Summary

Methods
Properties
Constants
getName()
setName()
getMembers()
setMembers()
getChildGroups()
setChildGroups()
getAutoUpdate()
setAutoUpdate()
getTags()
setTags()
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

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

getMembers()

getMembers() : array<mixed,string>

Get a list of MSISDNs that belong to this group.

Returns

array<mixed,string> —

zero or more MSISDNs

setMembers()

setMembers(array<mixed,string>  $members) : void

Set the list of MSISDNs that belong to this group.

Parameters

array<mixed,string> $members

zero or more MSISDNs

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

getTags()

getTags() : array<mixed,string>

Get the tags associated to this group.

Returns

array<mixed,string> —

the group tags

setTags()

setTags(array<mixed,string>  $tags) : void

Set the tags associated to this group.

Parameters

array<mixed,string> $tags

the group tags