Caplin.StreamLink.IPermissionEvent Interface Reference

Provides information about a change to permission data. More...

Inheritance diagram for Caplin.StreamLink.IPermissionEvent:

Public Member Functions
bool	DeleteAllKeys ()
	Returns the boolean that indicates whether all permission keys for this subject have been deleted. More...
bool	DeleteKey ()
	Returns the boolean that indicates whether the permission key within this update has been deleted. More...

Properties
IDictionary< string, string >	Fields [get]
	Returns the collection of fields relating to this PermissionEvent. More...
string	Key [get]
	Returns the permission key relating to this event. More...
Properties inherited from Caplin.StreamLink.IDataEvent
bool	IsImage [get]
	Returns whether this was an image event or an update event. More...
string	Subject [get]
	Returns the subject to which the event relates. More...

Detailed Description

Provides information about a change to permission data.

Member Function Documentation

bool Caplin.StreamLink.IPermissionEvent.DeleteAllKeys

(

)

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

• If true, all permission data for this subject should be removed from your cache.

bool Caplin.StreamLink.IPermissionEvent.DeleteKey

(

)

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

• Whether the specified key should be deleted from your cache.

Property Documentation

IDictionary<string,string> Caplin.StreamLink.IPermissionEvent.Fields

get

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.

• A collection of name-value pairs.

string Caplin.StreamLink.IPermissionEvent.Key

get

Returns the permission key relating to this event.

• The value of the permission key.