com.pushtechnology.diffusion.client.features.control.clients

Interface ClientControl.SessionEventParameters.Builder

Enclosing interface:

ClientControl.SessionEventParameters

public static interface ClientControl.SessionEventParameters.Builder

A builder for SessionEventParameters. An instance of such a builder is created using Diffusion.newSessionEventParametersBuilder().

Method Summary

Modifier and Type	Method and Description
ClientControl.SessionEventParameters.Builder	after(Instant time) Used to indicate that events are only to be reported for sessions that start after a specified time.
ClientControl.SessionEventParameters	build() Builds a new SessionEventParameters instance with the current settings of the builder.
ClientControl.SessionEventParameters.Builder	filter(String filter) Sets a session filter which will determine which sessions events will be notified for.
ClientControl.SessionEventParameters.Builder	properties(String... properties) Specifies the session property keys of all session properties to be returned with events.

Method Detail

filter

ClientControl.SessionEventParameters.Builder filter(String filter)

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

See Session 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.

Parameters:

filter - the session filter

Returns:

this builder

properties

ClientControl.SessionEventParameters.Builder properties(String... properties)

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

See Session for a full list of available fixed property keys.

To request all fixed properties include Session.ALL_FIXED_PROPERTIES as a key. In this case any other fixed property keys would be ignored.

To request all user properties include Session.ALL_USER_PROPERTIES 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.

Parameters:

properties - a list of required property keys

Returns:

this builder

after

ClientControl.SessionEventParameters.Builder after(Instant time)

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

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 after(Instant.now()) could be used.

Parameters:

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

Returns:

this builder

build

ClientControl.SessionEventParameters build()

Builds a new SessionEventParameters instance with the current settings of the builder.

Returns:

a new SessionEventParameters instance