Declaration Syntax Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | AddField(String, String) |
Adds the given field with the given value.
|
| ContainsField(String) |
Determines whether the permission message contains the specified field.
|
 | DeletePermissionKey |
Gets or sets a value indicating whether this permission key should be deleted.
|
| Fields |
Gets the fields within this permission message.
|
| Global |
Gets or sets a value indicating whether this IPermissionMessage is a global permission message.
|
| Image |
Gets or sets a boolean value indicating whether this IMessage represents an image or an update.
(Inherited from IMessage.) |
| Item[([(String])]) |
Gets or sets a specified field within this permission message.
|
| PermissionKey |
Gets or sets the permission key.
|
| RemoveField(String) |
Removes all instances of the given field from this permission message.
|
| Subject |
Gets the subject of this message.
(Inherited from IMessage.) |
RemarksPermission messages are a type of DataSource subject that can be used to send information to both a StreamLink client and to the Authentication Module within the Liberator.
They can be conceived as a 2-dimensional array (like an IRecordType2Message) or a table structure with the PermissionKey as the secondary index and the field/value pairs as column keys/values. The following table is an illustration of how they could be utilised by your DataSource, Authentication Module and StreamLink clients.
| PermissionKey | Read | Write | Delete |
| PERMZONE1 | YES | YES | YES |
| PERMZONE1 | YES | YES | NO |
| PERMZONE1 | YES | NO | NO |
Permission messages have the unique feature of being passed through the Authentication Module in the Liberator prior to being sent to StreamLink clients.
The Authentication Module can take actions based on the content of the permission messages it receives. For example, if a permission message determines the price tier to which a customer belongs, the Authentication Module could retain the tier information for future reference and prevent the message from being forwarded to the subscribing client (since this information should not be made available to customers).
Permission messages marked as "Global" are also passed into the Authentication Module within the Liberator when received from a DataSource. Such messages are typically used to provide the Authentication Module with authentication and authorization information about customers (such as username and password)
An object implementing this interface cannot be instantiated directly, but can be constructed using the IMessageFactory that is available on the IPublisher interface.