Class SessionEventParametersBuilder

Namespace

PushTechnology.ClientInterface.Client.Features.Metrics

Assembly

Diffusion.Client.dll

Builder for ISessionEventParameters.

public sealed class SessionEventParametersBuilder : ISessionEventParametersBuilder

Inheritance

object

SessionEventParametersBuilder

Implements

ISessionEventParametersBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Methods

After(DateTime?)

Used to indicate that events are only to be reported for sessions that start after a specified time.

public ISessionEventParametersBuilder After(DateTime? time)

Parameters

time DateTime?

Only sessions starting after the specified time will be notified. Specifying null will remove any previously specified time from the builder.

Returns

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.

public ISessionEventParameters Build()

Returns

ISessionEventParameters

A new ISessionEventParameters instance.

Filter(string)

Sets a session filter which will determine which sessions events will be notified for.

public ISessionEventParametersBuilder Filter(string filter)

Parameters

filter string

The session filter.

Returns

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(params string[])

Specifies the session property keys of all session properties to be returned with events.

public ISessionEventParametersBuilder Properties(params string[] properties)

Parameters

properties string[]

A list of required property keys.

Returns

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.

ToString()

public override string ToString()

Returns

string