Satori.IClient Interface Reference

A client for the API in Satori server. More...

Inheritance diagram for Satori.IClient:

Public Member Functions
Task< ISession >	AuthenticateAsync (string id, Dictionary< string, string > defaultProperties=default, Dictionary< string, string > customProperties=default, CancellationToken? cancellationToken=default)
	Authenticate against the server.
Task	AuthenticateLogoutAsync (ISession session, CancellationToken? cancellationToken=default)
	Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
Task	EventAsync (ISession session, Event @event, CancellationToken? cancellationToken=default)
	Send an event for this session.
Task	EventsAsync (ISession session, IEnumerable< Event > events, CancellationToken? cancellationToken=default)
	Send a batch of events for this session.
Task< IApiExperimentList >	GetAllExperimentsAsync (ISession session, CancellationToken? cancellationToken=default)
	Get all experiments data.
Task< IApiExperimentList >	GetExperimentsAsync (ISession session, IEnumerable< string > names, CancellationToken? cancellationToken=default)
	Get specific experiments data.
Task< IApiFlag >	GetFlagAsync (ISession session, string name, CancellationToken? cancellationToken=default)
	Get a single flag for this identity.
Task< IApiFlag >	GetFlagAsync (ISession session, string name, string defaultValue, CancellationToken? cancellationToken=default)
	Get a single flag for this identity.
Task< IApiFlag >	GetFlagDefaultAsync (string name, CancellationToken? cancellationToken=default)
	Get a single default flag for this identity.
Task< IApiFlag >	GetFlagDefaultAsync (string name, string defaultValue, CancellationToken? cancellationToken=default)
	Get a single default flag for this identity.
Task< IApiFlagList >	GetFlagsAsync (ISession session, IEnumerable< string > names, CancellationToken? cancellationToken=default)
	List all available flags for this identity.
Task< IApiFlagList >	GetFlagsDefaultAsync (IEnumerable< string > names, CancellationToken? cancellationToken=default)
	List all available default flags.
Task< IApiLiveEventList >	GetLiveEventsAsync (ISession session, IEnumerable< string > names=null, CancellationToken? cancellationToken=default)
	List available live events.
Task< ISession >	IdentifyAsync (ISession session, string id, Dictionary< string, string > defaultProperties, Dictionary< string, string > customProperties, CancellationToken? cancellationToken=default)
	Identify a session with a new ID.
Task< IApiProperties >	ListPropertiesAsync (ISession session, CancellationToken? cancellationToken=default)
	List properties associated with this identity.
Task< ISession >	SessionRefreshAsync (ISession session, CancellationToken? cancellationToken=default)
	Refresh a user's session using a refresh token retrieved from a previous authentication request.
Task	UpdatePropertiesAsync (ISession session, Dictionary< string, string > defaultProperties, Dictionary< string, string > customProperties, bool recompute, CancellationToken? cancellationToken=default)
	Update properties associated with this identity.
Task	DeleteIdentityAsync (ISession session, CancellationToken? cancellationToken=default)
	Delete the caller's identity and associated data.
Task< IApiGetMessageListResponse >	GetMessageListAsync (ISession session, int limit=1, bool forward=true, string cursor=null, CancellationToken? cancellationToken=default)
	Get all the messages for an identity.
Task	UpdateMessageAsync (ISession session, string id, string consumeTime, string readTime, CancellationToken? cancellationToken=default)
	Update the status of a message.
Task	DeleteMessageAsync (ISession session, string id, CancellationToken? cancellationToken=default)
	Delete a scheduled message.

Properties
bool	AutoRefreshSession [get]
	True if the session should be refreshed with an active refresh token.

Detailed Description

A client for the API in Satori server.

Member Function Documentation

AuthenticateAsync()

Task< ISession > Satori.IClient.AuthenticateAsync	(	string	id,
		Dictionary< string, string >	defaultProperties = default,
		Dictionary< string, string >	customProperties = default,
		CancellationToken?	cancellationToken = default )

Authenticate against the server.

Parameters

id

An optional user id.

defaultProperties

Optional default properties to update with this call. If not set, properties are left as they are on the server. Parameters customProperties Optional custom properties to update with this call. If not set, properties are left as they are on the server. Parameters cancellationToken The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a user session.

Implemented in Satori.Client.

AuthenticateLogoutAsync()

Task Satori.IClient.AuthenticateLogoutAsync	(	ISession	session,
		CancellationToken?	cancellationToken = default )

Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.

Parameters

session	The session of the user.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implemented in Satori.Client.

DeleteIdentityAsync()

Task Satori.IClient.DeleteIdentityAsync	(	ISession	session,
		CancellationToken?	cancellationToken = default )

Delete the caller's identity and associated data.

Parameters

session	The session of the user.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task object.

Implemented in Satori.Client.

DeleteMessageAsync()

Task Satori.IClient.DeleteMessageAsync	(	ISession	session,
		string	id,
		CancellationToken?	cancellationToken = default )

Delete a scheduled message.

Parameters

session	The session of the user.
id	The identifier of the message.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task object.

Implemented in Satori.Client.

EventAsync()

Task Satori.IClient.EventAsync	(	ISession	session,
		Event @	event,
		CancellationToken?	cancellationToken = default )

Send an event for this session.

Parameters

session	The session of the user.
event	The event to send.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task object.

Implemented in Satori.Client.

EventsAsync()

Task Satori.IClient.EventsAsync	(	ISession	session,
		IEnumerable< Event >	events,
		CancellationToken?	cancellationToken = default )

Send a batch of events for this session.

Parameters

session	The session of the user.
events	The batch of events which will be sent.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task object.

Implemented in Satori.Client.

GetAllExperimentsAsync()

Task< IApiExperimentList > Satori.IClient.GetAllExperimentsAsync	(	ISession	session,
		CancellationToken?	cancellationToken = default )

Get all experiments data.

Parameters

session	The session of the user.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to all experiments that this identity is involved with.

Implemented in Satori.Client.

GetExperimentsAsync()

Task< IApiExperimentList > Satori.IClient.GetExperimentsAsync	(	ISession	session,
		IEnumerable< string >	names,
		CancellationToken?	cancellationToken = default )

Get specific experiments data.

Parameters

session	The session of the user.
names	Experiment names.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to all experiments that this identity is involved with.

Implemented in Satori.Client.

GetFlagAsync() [1/2]

Task< IApiFlag > Satori.IClient.GetFlagAsync	(	ISession	session,
		string	name,
		CancellationToken?	cancellationToken = default )

Get a single flag for this identity.

Parameters

session	The session of the user.
name	The name of the flag.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a single feature flag.

Implemented in Satori.Client.

GetFlagAsync() [2/2]

Task< IApiFlag > Satori.IClient.GetFlagAsync	(	ISession	session,
		string	name,
		string	defaultValue,
		CancellationToken?	cancellationToken = default )

Get a single flag for this identity.

Unlike GetFlags(ISession,string,CancellationToken) this method will return the default value specified and will not raise an exception if the network is unavailable.

Parameters

session	The session of the user.
name	The name of the flag.
defaultValue	The default value if the server is unreachable.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a single feature flag.

Implemented in Satori.Client.

GetFlagDefaultAsync() [1/2]

Task< IApiFlag > Satori.IClient.GetFlagDefaultAsync	(	string	name,
		CancellationToken?	cancellationToken = default )

Get a single default flag for this identity.

Parameters

name	The name of the flag.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a single default feature flag.

Implemented in Satori.Client.

GetFlagDefaultAsync() [2/2]

Task< IApiFlag > Satori.IClient.GetFlagDefaultAsync	(	string	name,
		string	defaultValue,
		CancellationToken?	cancellationToken = default )

Get a single default flag for this identity.

Unlike GetFlagDefaultAsync(string,string,CancellationToken) this method will return the default value specified and will not raise an exception if the network is unreachable.

Parameters

name	The name of the flag.
defaultValue	The default value if the server is unreachable.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a single default feature flag.

Implemented in Satori.Client.

GetFlagsAsync()

Task< IApiFlagList > Satori.IClient.GetFlagsAsync	(	ISession	session,
		IEnumerable< string >	names,
		CancellationToken?	cancellationToken = default )

List all available flags for this identity.

Parameters

session	The session of the user.
names	Flag names, if empty string all flags are returned.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to all flags available to this identity.

Implemented in Satori.Client.

GetFlagsDefaultAsync()

Task< IApiFlagList > Satori.IClient.GetFlagsDefaultAsync	(	IEnumerable< string >	names,
		CancellationToken?	cancellationToken = default )

List all available default flags.

Parameters

names	Flag names, if empty string all flags are returned.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to all available default flags.

Implemented in Satori.Client.

GetLiveEventsAsync()

Task< IApiLiveEventList > Satori.IClient.GetLiveEventsAsync	(	ISession	session,
		IEnumerable< string >	names = null,
		CancellationToken?	cancellationToken = default )

List available live events.

Parameters

session	The session of the user.
names	Live event names, if null or empty, all live events are returned.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a list of live events.

Implemented in Satori.Client.

GetMessageListAsync()

Task< IApiGetMessageListResponse > Satori.IClient.GetMessageListAsync	(	ISession	session,
		int	limit = 1,
		bool	forward = true,
		string	cursor = null,
		CancellationToken?	cancellationToken = default )

Get all the messages for an identity.

Parameters

session	The session of the user.
limit	Max number of messages to return. Between 1 and 100.
forward	True if listing should be older messages to newer, false if reverse.
cursor	A pagination cursor, if any.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task object which resolves to a list of messages.

Implemented in Satori.Client.

IdentifyAsync()

Task< ISession > Satori.IClient.IdentifyAsync	(	ISession	session,
		string	id,
		Dictionary< string, string >	defaultProperties,
		Dictionary< string, string >	customProperties,
		CancellationToken?	cancellationToken = default )

Identify a session with a new ID.

Parameters

session	The session of the user.
id	Identity ID to enrich the current session and return a new session. The old session will no longer be usable. Must be between eight and 128 characters (inclusive). Must be an alphanumeric string with only underscores and hyphens allowed.
defaultProperties	The default properties.
customProperties	The custom event properties.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the new session for the user.

Implemented in Satori.Client.

ListPropertiesAsync()

Task< IApiProperties > Satori.IClient.ListPropertiesAsync	(	ISession	session,
		CancellationToken?	cancellationToken = default )

List properties associated with this identity.

Parameters

session	The session of the user.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a list of live events.

Implemented in Satori.Client.

SessionRefreshAsync()

Task< ISession > Satori.IClient.SessionRefreshAsync	(	ISession	session,
		CancellationToken?	cancellationToken = default )

Refresh a user's session using a refresh token retrieved from a previous authentication request.

Parameters

session	The session of the user.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a user session.

Implemented in Satori.Client.

UpdateMessageAsync()

Task Satori.IClient.UpdateMessageAsync	(	ISession	session,
		string	id,
		string	consumeTime,
		string	readTime,
		CancellationToken?	cancellationToken = default )

Update the status of a message.

Parameters

session	The session of the user.
id	The message's unique identifier.
consumeTime	The time the message was consumed by the identity.
readTime	The time the message was read at the client.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task object.

Implemented in Satori.Client.

UpdatePropertiesAsync()

Task Satori.IClient.UpdatePropertiesAsync	(	ISession	session,
		Dictionary< string, string >	defaultProperties,
		Dictionary< string, string >	customProperties,
		bool	recompute,
		CancellationToken?	cancellationToken = default )

Update properties associated with this identity.

Parameters

session	The session of the user.
defaultProperties	The default properties to update.
customProperties	The custom properties to update.
recompute	Whether or not to recompute the user's audience membership immediately after property update.
cancellationToken	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task object.

Implemented in Satori.Client.

Property Documentation

AutoRefreshSession

bool Satori.IClient.AutoRefreshSession

get

True if the session should be refreshed with an active refresh token.

Implemented in Satori.Client.

---

The documentation for this interface was generated from the following file:

• Satori/IClient.cs