new XmlPushDestination()
Definition of a push destination.
When using these XML elements to set a push destination, if both the "resource-attr-guid" attribute and "value" elements are specified, the "value" elements will be ignored.
The value elements are used to pass the values of the push destination. If the push destination:
- retrieves its value from an LDAP attribute (via a resource-attr-guid arameter descriptor) it can hold multiple values, so the value element can occur several times.
- does not take its value from an LDAP attribute, it can hold only one value. If multiple values are given when setting the push destination, only the first value is recorded.
Constructs a new XmlPushDestination.
The following features are supported:
Extends
Members
channelId :string
Unique ID of the channel associated with this push destination.
This property holds the value of the 'Channel Id' attribute.
Type:
- string
- Inherited From:
channelType :tibco.objectapi.common.channeltype.ChannelType
Enumerated type defining the presentation technology used by the channel associated with this push destination.
This property holds the value of the 'Channel Type' attribute.
Type:
- Inherited From:
enabled :boolean
Boolean value indicating whether this push destination is currently enabled (TRUE) or not (FALSE).
This property holds the value of the 'Enabled' attribute.
Type:
- boolean
name :string
The name of the push destination.
This property holds the value of the 'Name' attribute.
Type:
- string
- Inherited From:
resourceAttrGuid :string
Unique ID of a resource attribute whose value should be used for the push destination. The parameter descriptor must be assigned to the organization model entity for whom the push destination is being set. If a value is assigned to both this attribute and the "value" element, the value of this attribute will be used.
This property holds the value of the 'Resource Attr Guid' attribute.
Type:
- string
value :Array.<string>
Value to be used for this push destination.
When setting a push destination, this value is only used if no resource-attr-guid attribute is supplied.
When reading a push destination, this is the explicit value or the value(s) held by the Resource attribute identified by the resource-attr-guid attribute.
This property holds the value of the 'Value' attribute list.
Type:
- Array.<string>