Object attribute reference

This topic describes the attributes available for each object type and provides the data type and whether the attribute is read, write, or both read and write.

Community object

Table 1. Community object type and attributes

Attribute	Description	Data type	Read (R) or Write (W)
uid	Unique identifier	String	R
name	The name of the community	String	RW
domains	List of domains	String	RW
customProperties	Community custom properties	List: custom properties	RW
internal	Indicates if the community is a local (internal=true) or external (internal=false) community	Boolean	RW
clearingHouse	Indicates if the community is a clearing house community (true)	Boolean	RW
protocolConnector	The translation protocol used by this community	ProtocolConnector	RW
sTGWServer	The connections defined for the community.	List: STGWServer	R (W only on community creation)

STGWServer object

Table 2. STGWServer object type and attributes

Attribute	Description	Data type	Read (R) or Write (W)
uid	Unique identifier	String	R
name	The name of the connection	String	RW
transport	The transport type for this connection. Accepted values: TCP or TLS	String	RW
hostname	The host name for this connection	String	RW
port	The port number for this connection.	Integer	RW

ProtocolConnector Object

Table 3. ProtocolConnect object type and attributes

Attribute	Description	Data type	Read (R) or Write (W)
uid	Unique identifier	String	R
name	Name of connector	String	RW
protocol	The translation protocol supported by this connector. Accepted values include SIP for Sametime®, SIP for legacy Sametime servers, SIP for AOL, SIP for OCS, VP, and XMPP.	String	RW
customProperties	Custom properties for the translation protocol such as subscription timeout or session timeout.	List: customProperties	RW

MessageHandler Object

Table 4. MessageHandler object type and attributes

Attribute	Description	Data type	Read (R) or Write (W)
uid	Unique identifier	String	R
name	Name of the community.	String	RW
customProperties	Custom properties for the message handler.	List: CustomProperties	RW
mandatory	Run the message handler regardless of whether a previously run message handler completed its process or encountered an error.	Boolean	RW
order	Specifies the order of precedence of the message handlers.	Integer	RW
type	The message handler type. Accepted values are: undefined, Event logger, Authorization controller, User locator, and other	String	RW

Route Object

Table 5. Route object type and attributes

Attribute	Description	Data type	Read (R) or Write (W)
uid	Unique identifier	String	R
source	The local community.	Hash table	R
destination	The destination or external community.	Hash table	R
enabled	Indicates if the route is enabled or disabled.	Boolean	RW
capabilities	Capabilities such as instant messaging and presence for the route. Only 2 is valid. 0 = instant messaging 1 = presence 2 = both capabilities	Integer	RW

Access Control List (ACL) Object

Table 6. Access Control List object type and attributes

Attribute	Description	Data type	Read (R) or Write (W)
users	The Virtual Member Manager (VMM) IDs of the users whom are on this access control list.	List : String	RW
groups	The VMM IDs of the groups whom are on this access control list.	List : String	RW

CustomProperty Object

Table 7. CustomProperty object type and attributes

Attribute	Description	Data type	Read (R) or Write (W)
uid	Unique identifier	String	R
name	Name of the community.	String	R (Write only on creation.)
value	Value of the property.		RW
required		Boolean	RW
description	Text description of the custom property	String	RW