Class
caplin.streamlink

PermissionEvent

Provides information about a change to permission data.

Constructor Summary

Attributes Name and Description
caplin.streamlink.PermissionEvent()

Method Summary

Attributes Name and Description
void deleteAllKeys()

*

Returns the boolean that indicates whether all permission keys for this subject have been deleted.

void deleteKey()

*

Returns the boolean that indicates whether the permission key within this update has been deleted.

void getFields()

*

Returns the collection of fields relating to this PermissionEvent.

void getKey()

*

Returns the permission key relating to this event.

Methods inherited from class caplin.streamlink.DataEvent:
getSubject, isImage

Constructor Detail

caplin.streamlink.PermissionEvent()

Method Detail

void deleteAllKeys()

*

Returns the boolean that indicates whether all permission keys for this subject have been deleted.

* * @returns {boolean} If true, all permission data for this subject should be removed from your cache.

void deleteKey()

*

Returns the boolean that indicates whether the permission key within this update has been deleted.

* * @returns {boolean} Whether the specified key should be deleted from your cache.

void getFields()

*

Returns the collection of fields relating to this PermissionEvent.

* *

For example, if this event is not an image, the fields are the ones that have been updated.

* * @returns {Object} A collection of name-value pairs.

void getKey()

*

Returns the permission key relating to this event.

* * @returns {String} The value of the permission key.