\Clx\Xms\ApiGroupUpdate

getName()

getName() : string|null|\Clx\Xms\Api\Reset

Gets the group name update.

If null then the current value is kept, if Reset::reset() then the value is reset to its XMS default, and if set to a string the name is updated.

Returns

the update action

resetName()

resetName() : void

Resets group name field to the XMS default value.

setName()

setName(string  $name) : void

Set the new group name.

Parameters

getMemberInsertions()

getMemberInsertions() : array<mixed,string>|null

Get the MSISDNs that should be added to this group.

Returns

a list of group members to add

setMemberInsertions()

setMemberInsertions(array<mixed,string>  $memberInsertions) : void

Set the MSISDNs that should be added to this group.

Parameters

getMemberRemovals()

getMemberRemovals() : array<mixed,string>|null

Get the MSISDNs that should be removed from this group.

Returns

a list of group members to remove

setMemberRemovals()

setMemberRemovals(array<mixed,string>  $memberRemovals) : void

Set the MSISDNs that should be removed from this group.

Parameters

getChildGroupInsertions()

getChildGroupInsertions() : array<mixed,string>|null

Get the child groups that should be added to this group.

Returns

a list of group IDs

setChildGroupInsertions()

setChildGroupInsertions(array<mixed,string>  $childGroupInsertions) : void

Set the child groups that should be added to this group.

Parameters

getChildGroupRemovals()

getChildGroupRemovals() : array<mixed,string>|null

Get the child groups that should be removed from this group.

Returns

a list of group IDs

setChildGroupRemovals()

setChildGroupRemovals(array<mixed,string>  $childGroupRemovals) : void

Set the child groups that should be removed from this group.

Parameters

getAddFromGroup()

getAddFromGroup() : string|null

Get identifier of the group whose members should be added to this group.

Returns

a group ID

setAddFromGroup()

setAddFromGroup(string  $addFromGroup) : void

Set identifier of a group whose members should be added to this group.

Parameters

getRemoveFromGroup()

getRemoveFromGroup() : string|null

Get identifier of the group whose members should be removed from this group.

Returns

a group ID

setRemoveFromGroup()

setRemoveFromGroup(string  $removeFromGroup) : void

Set identifier of a group whose members should be removed from this group.

Parameters

getAutoUpdate()

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

Get description of how this group should be auto updated.

If null then the current value is kept, if Reset::reset() then the value is reset to its XMS default, and if set to a GroupAutoUpdate the value is updated.

Returns

an auto update description

resetAutoUpdate()

resetAutoUpdate() : void

Resets group auto update field to the XMS default value.

setAutoUpdate()

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

Set a new group auto update description.

Parameters