Class PermissionEvent

Name

PermissionEvent

Hierarchy

Constructors

constructor

Methods

deleteAllKeys deleteKey getFields getKey getSubject isImage

Constructors

constructor

Methods

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.

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.

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 {
        [key: string]: string;
    }

    A collection of name-value pairs.

    • [key: string]: string

getKey

  • Returns the permission key relating to this event.

    Returns string

    The value of the permission key.

getSubject

  • Returns the subject to which the event relates.

    Returns string

    the subject

isImage

  • Returns whether this was an image event or an update event.

    If this method returns true, all data for the subject is contained within this event; you should therefore clear the application's caches of any current data for the subject of this event before refreshing them with the new data.

    Returns boolean

    true if this event contains all data for the subject (an "image"), false if the event contains only some of the data (an "update").

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc