Interface ISessionEventParametersBuilder
A builder for ISessionEventParameters.
Namespace: PushTechnology.ClientInterface.Client.Features.Control.Clients
Assembly: Diffusion.Client.dll
Syntax
public interface ISessionEventParametersBuilderRemarks
An instance of such a builder is created using NewSessionEventParametersBuilder().
Methods
After(Nullable<DateTime>)
Used to indicate that events are only to be reported for sessions that start after a specified time.
Declaration
ISessionEventParametersBuilder After(DateTime? time)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<DateTime> | time | Only sessions starting after the specified time will be notified. Specifying null will remove any previously specified time from the builder. |
Returns
| Type | Description |
|---|---|
| ISessionEventParametersBuilder | This builder. |
Remarks
If this is not set, the default is to notify events for all current sessions, even if they started before registration of the listener. This could potentially result in a large number of events for all current sessions.
If the user is only interested in new sessions
current sessions, even if they started before registration of the
After(DateTime.Now) could be used.
Build()
Builds a new ISessionEventParameters instance with the current settings of the builder.
Declaration
ISessionEventParameters Build()Returns
| Type | Description |
|---|---|
| ISessionEventParameters | A new ISessionEventParameters instance. |
Filter(String)
Sets a session filter which will determine which sessions events will be notified for.
Declaration
ISessionEventParametersBuilder Filter(string filter)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filter | The session filter. |
Returns
| Type | Description |
|---|---|
| ISessionEventParametersBuilder | This builder. |
Remarks
See ISession for a full description of how to specify session filters.
If no filter is specified then notifications will be provided for all sessions that satisfy any other specified requirements.
Specifying null will remove any current filter from the
builder.
Properties(String[])
Specifies the session property keys of all session properties to be returned with events.
Declaration
ISessionEventParametersBuilder Properties(params string[] properties)Parameters
| Type | Name | Description |
|---|---|---|
| System.String[] | properties | A list of required property keys. |
Returns
| Type | Description |
|---|---|
| ISessionEventParametersBuilder | This builder. |
Remarks
See ISession for a full list of available fixed property keys.
To request all fixed properties include AllFixedProperties as a key. In this case any other fixed property keys would be ignored.
To request all user properties include AllUserProperties as a key. In this case any other user properties are ignored.
If this is not specified (or no property keys are provided) then no session property values will be returned with the events and events of type PROPERTIES will not be notified.