Auki::ConjureKit::Domains::IDomainSdk

Generic interface for Domains API.

Inherited by Auki.ConjureKit.IConjureKit

Public Functions

	Name
string	GetAppOrganizationId() Returns the Organization Id of the App. Requires ConjureKit to be initialized.
bool	IsLoggedIn() Returns if any user is currently logged in. Requires ConjureKit to be initialized.
bool	IsUserLoggedIn(string username) Returns if the given user is currently logged in. Requires ConjureKit to be initialized.
string	GetLoggedInUserOrganizationId() Returns the Organization Id of the logged in User, if available. Requires ConjureKit to be initialized.
void	Login(string username, string password, Action onSuccess, Action< string > onFailure) Login with user credentials. Requires ConjureKit to be initialized. May be called several times, overwriting previous previous credentials and login state.
void	Logout() Logs out currently logged in user, if any. You can Login() again immediately after this call. May be called any time. Any currently used login data will be cleared immediately, even if the server is unreachable or the request fails.
void	GetLighthouse(string lighthouseId, Action< StaticLighthouse > onSuccess, Action< string > onFailure, bool preferCache =false) Retrieves a specific lighthouse by its Id or Short Id. Result might differ depending on the user currently logged in. Requires ConjureKit to be initialized.
void	GetLighthouseWithDomains(string lighthouseId, OrganizationSource domainOrgFilter, Action< StaticLighthouse > onSuccess, Action< string > onFailure) Retrieves a specific lighthouse by its Id or Short Id, plus additional information on Domains it belongs to. Result might differ depending on the user currently logged in. Requires ConjureKit to be initialized.
void	GetLighthouses(OrganizationSource orgFilter, Action< IReadOnlyCollection< StaticLighthouse > > onSuccess, Action< string > onFailure) Retrieves all lighthouses created/owned by the organization currently in use. Result might differ depending on the user currently logged in. Requires ConjureKit to be initialized.
void	GetLighthouses(string organizationId, Action< IReadOnlyCollection< StaticLighthouse > > onSuccess, Action< string > onFailure) Retrieve all existing StaticLighthouses in the specified organization, accessible at the current time. Result might differ depending on logged in status and the user currently logged in. Note: you can use your own organization id to retrieve lighthouses created by your organization. Requires ConjureKit to be initialized.
void	GetLighthousesFromDomain(string domainId, OrganizationSource domainOrgFilter, Action< IReadOnlyCollection< DomainAssociation > > onSuccess, Action< string > onFailure) Retrieves all lighthouses currently added to a specific domain. Result might differ depending on logged in status and the user currently logged in. Currently only OrganizationSource.Any is supported for this function; other values will be ignored. This is intended for future support. Requires ConjureKit to be initialized.
void	GetDomain(string domainId, Action< Domain > onSuccess, Action< string > onFailure, bool preferCache =false) Retrieves a specific domain information by its id. Result might differ depending on the user currently logged in. Requires ConjureKit to be initialized.
void	GetDomainWithLighthouses(string domainId, OrganizationSource lighthouseOrgFilter, Action< Domain > onSuccess, Action< string > onFailure) Retrieves a specific domain information by its id, plus additional information on Lighthouses associated to it. Currently only OrganizationSource.Any is supported for this function; other values will be ignored. This is intended for future support. Requires ConjureKit to be initialized.
void	GetDomains(OrganizationSource orgFilter, Action< IReadOnlyCollection< Domain > > onSuccess, Action< string > onFailure) Retrieve all existing Domains created/owned by the organization currently in use. Result might differ depending on logged in status and the user currently logged in: app organization will be used, unless a user is logged in, in which case his organization is used. Requires ConjureKit to be initialized.
void	GetDomains(string organizationId, Action< IReadOnlyCollection< Domain > > onSuccess, Action< string > onFailure) Retrieve all existing Domains created by the specified organization, accessible at the current time. Result might differ depending on logged in status and the user currently logged in. Note: you can use your own organization id to retrieve domains created by your organization. Requires ConjureKit to be initialized.
void	GetDomainsFromLighthouse(string lighthouseId, OrganizationSource domainOrgFilter, Action< IReadOnlyCollection< DomainAssociation > > onSuccess, Action< string > onFailure) Retrieve all existing Domains created by the specified organization, accessible at the current time. Retrieve all Domain objects that contain a specific lighthouse, accessible at the current time. Result might differ depending on logged in status and the user currently logged in. Note: you can use your own organization id to retrieve domains created by your organization. Requires ConjureKit to be initialized.

Public Properties

	Name
IReadOnlyDictionary< string, StaticLighthouse >	StaticLighthousesCached Cache of currently known StaticLighthouses, indexed by Id. Note: this property provides quick access to locally downloaded data from previous requests. It is not kept in sync with the server and thus might be not up to date. Requires ConjureKit to be initialized.
IReadOnlyDictionary< string, Domain >	DomainsCached Cache of currently known Domains, indexed by Id. Note: this property provides quick access to locally downloaded data from previous requests. It is not kept in sync with the server and thus might be not up to date. Requires ConjureKit to be initialized.

Public Functions Documentation

function GetAppOrganizationId

string GetAppOrganizationId()

Returns the Organization Id of the App. Requires ConjureKit to be initialized.

Return: The organization id or empty if not available.

Reimplemented by: Auki::ConjureKit::ConjureKit::GetAppOrganizationId

function IsLoggedIn

bool IsLoggedIn()

Returns if any user is currently logged in. Requires ConjureKit to be initialized.

Return: True if logged in.

Reimplemented by: Auki::ConjureKit::ConjureKit::IsLoggedIn

function IsUserLoggedIn

bool IsUserLoggedIn(
    string username
)

Returns if the given user is currently logged in. Requires ConjureKit to be initialized.

Return: True if logged in.

Reimplemented by: Auki::ConjureKit::ConjureKit::IsUserLoggedIn

function GetLoggedInUserOrganizationId

string GetLoggedInUserOrganizationId()

Returns the Organization Id of the logged in User, if available. Requires ConjureKit to be initialized.

Return: The organization id or empty if not available (user not logged in).

Reimplemented by: Auki::ConjureKit::ConjureKit::GetLoggedInUserOrganizationId

function Login

void Login(
    string username,
    string password,
    Action onSuccess,
    Action< string > onFailure
)

Login with user credentials. Requires ConjureKit to be initialized. May be called several times, overwriting previous previous credentials and login state.

Parameters:

• username Auki console username.
• password Auki console password.
• onSuccess A callback for handling successful login.
• onFailure A callback for handling failures, providing an error message.

Reimplemented by: Auki::ConjureKit::ConjureKit::Login

function Logout

void Logout()

Logs out currently logged in user, if any. You can Login() again immediately after this call. May be called any time. Any currently used login data will be cleared immediately, even if the server is unreachable or the request fails.

Reimplemented by: Auki::ConjureKit::ConjureKit::Logout

function GetLighthouse

void GetLighthouse(
    string lighthouseId,
    Action< StaticLighthouse > onSuccess,
    Action< string > onFailure,
    bool preferCache =false
)

Retrieves a specific lighthouse by its Id or Short Id. Result might differ depending on the user currently logged in. Requires ConjureKit to be initialized.

Parameters:

• lighthouseId The unique identifier of the lighthouse.
• onSuccess A callback for handling the successful retrieval of the lighthouse.
• onFailure A callback for handling failures, providing an error message. A missing lighthouse will trigger this callback.
• preferCache When true, avoids requesting again from server data already in cache, but can lead to out-of-sync data. Default = false.

Reimplemented by: Auki::ConjureKit::ConjureKit::GetLighthouse

function GetLighthouseWithDomains

void GetLighthouseWithDomains(
    string lighthouseId,
    OrganizationSource domainOrgFilter,
    Action< StaticLighthouse > onSuccess,
    Action< string > onFailure
)

Retrieves a specific lighthouse by its Id or Short Id, plus additional information on Domains it belongs to. Result might differ depending on the user currently logged in. Requires ConjureKit to be initialized.

Parameters:

• domainOrgFilter Filters domains by organization.
• lighthouseId The unique identifier of the lighthouse.
• onSuccess A callback for handling the successful retrieval of the lighthouse and all domains it is currently into.
• onFailure A callback for handling failures, providing an error message. A missing lighthouse will trigger this callback.

Reimplemented by: Auki::ConjureKit::ConjureKit::GetLighthouseWithDomains

function GetLighthouses

void GetLighthouses(
    OrganizationSource orgFilter,
    Action< IReadOnlyCollection< StaticLighthouse > > onSuccess,
    Action< string > onFailure
)

Retrieves all lighthouses created/owned by the organization currently in use. Result might differ depending on the user currently logged in. Requires ConjureKit to be initialized.

Parameters:

• orgFilter Filters lighthouses by organization.
• onSuccess A callback for handling the successful retrieval of lighthouses. No lighthouses will return an empty list.
• onFailure A callback for handling failures, providing an error message.

Reimplemented by: Auki::ConjureKit::ConjureKit::GetLighthouses

function GetLighthouses

void GetLighthouses(
    string organizationId,
    Action< IReadOnlyCollection< StaticLighthouse > > onSuccess,
    Action< string > onFailure
)

Retrieve all existing StaticLighthouses in the specified organization, accessible at the current time. Result might differ depending on logged in status and the user currently logged in. Note: you can use your own organization id to retrieve lighthouses created by your organization. Requires ConjureKit to be initialized.

Parameters:

• organizationId Any Organization id or "own" to use organization currently in use (logged in user or app).
• onSuccess Callback with a list of StaticLighthouse objects. No lighthouses will return an empty list.
• onFailure A callback for handling failures, providing an error message. A missing organization will trigger this callback.

Reimplemented by: Auki::ConjureKit::ConjureKit::GetLighthouses

function GetLighthousesFromDomain

void GetLighthousesFromDomain(
    string domainId,
    OrganizationSource domainOrgFilter,
    Action< IReadOnlyCollection< DomainAssociation > > onSuccess,
    Action< string > onFailure
)

Retrieves all lighthouses currently added to a specific domain. Result might differ depending on logged in status and the user currently logged in. Currently only OrganizationSource.Any is supported for this function; other values will be ignored. This is intended for future support. Requires ConjureKit to be initialized.

Parameters:

• domainId The unique identifier of the domain.
• domainOrgFilter Filters domains by organization. Only OrganizationSource.Any is currently supported.
• onSuccess A callback for handling the successful retrieval of lighthouses. No lighthouses will return an empty list.
• onFailure A callback for handling failures, providing an error message.

Reimplemented by: Auki::ConjureKit::ConjureKit::GetLighthousesFromDomain

function GetDomain

void GetDomain(
    string domainId,
    Action< Domain > onSuccess,
    Action< string > onFailure,
    bool preferCache =false
)

Retrieves a specific domain information by its id. Result might differ depending on the user currently logged in. Requires ConjureKit to be initialized.

Parameters:

• domainId The unique identifier of the lighthouse.
• onSuccess A callback for handling the successful retrieval of lighthouses.
• onFailure A callback for handling failures, providing an error message.
• preferCache When true, avoids requesting again from server data already in cache, but can lead to out-of-sync data. Default = false.

Reimplemented by: Auki::ConjureKit::ConjureKit::GetDomain

function GetDomainWithLighthouses

void GetDomainWithLighthouses(
    string domainId,
    OrganizationSource lighthouseOrgFilter,
    Action< Domain > onSuccess,
    Action< string > onFailure
)

Retrieves a specific domain information by its id, plus additional information on Lighthouses associated to it. Currently only OrganizationSource.Any is supported for this function; other values will be ignored. This is intended for future support. Requires ConjureKit to be initialized.

Parameters:

• domainId The unique identifier of the lighthouse.
• lighthouseOrgFilter Filters lighthouses by organization. Only OrganizationSource.Any is currently supported.
• onSuccess A callback for handling the successful retrieval of lighthouses.
• onFailure A callback for handling failures, providing an error message.

Reimplemented by: Auki::ConjureKit::ConjureKit::GetDomainWithLighthouses

function GetDomains

void GetDomains(
    OrganizationSource orgFilter,
    Action< IReadOnlyCollection< Domain > > onSuccess,
    Action< string > onFailure
)

Retrieve all existing Domains created/owned by the organization currently in use. Result might differ depending on logged in status and the user currently logged in: app organization will be used, unless a user is logged in, in which case his organization is used. Requires ConjureKit to be initialized.

Parameters:

• orgFilter Filters domains by organization
• onSuccess Callback with a list of Domain objects
• onFailure Callback on failure

Reimplemented by: Auki::ConjureKit::ConjureKit::GetDomains

function GetDomains

void GetDomains(
    string organizationId,
    Action< IReadOnlyCollection< Domain > > onSuccess,
    Action< string > onFailure
)

Retrieve all existing Domains created by the specified organization, accessible at the current time. Result might differ depending on logged in status and the user currently logged in. Note: you can use your own organization id to retrieve domains created by your organization. Requires ConjureKit to be initialized.

Parameters:

• organizationId Any Organization id or "own" to use organization currently in use (logged in user or app).
• onSuccess Callback with a list of Domain objects
• onFailure Callback on failure

Reimplemented by: Auki::ConjureKit::ConjureKit::GetDomains

function GetDomainsFromLighthouse

void GetDomainsFromLighthouse(
    string lighthouseId,
    OrganizationSource domainOrgFilter,
    Action< IReadOnlyCollection< DomainAssociation > > onSuccess,
    Action< string > onFailure
)

Retrieve all existing Domains created by the specified organization, accessible at the current time. Retrieve all Domain objects that contain a specific lighthouse, accessible at the current time. Result might differ depending on logged in status and the user currently logged in. Note: you can use your own organization id to retrieve domains created by your organization. Requires ConjureKit to be initialized.

Parameters:

• lighthouseId Lighthouse id
• domainOrgFilter Filters domains by organization.
• onSuccess Callback with a list of Domain objects
• onFailure Callback on failure

Reimplemented by: Auki::ConjureKit::ConjureKit::GetDomainsFromLighthouse

Public Property Documentation

property StaticLighthousesCached

IReadOnlyDictionary< string, StaticLighthouse > StaticLighthousesCached;

Cache of currently known StaticLighthouses, indexed by Id. Note: this property provides quick access to locally downloaded data from previous requests. It is not kept in sync with the server and thus might be not up to date. Requires ConjureKit to be initialized.

Reimplemented by: Auki::ConjureKit::ConjureKit::StaticLighthousesCached

property DomainsCached

IReadOnlyDictionary< string, Domain > DomainsCached;

Cache of currently known Domains, indexed by Id. Note: this property provides quick access to locally downloaded data from previous requests. It is not kept in sync with the server and thus might be not up to date. Requires ConjureKit to be initialized.

Reimplemented by: Auki::ConjureKit::ConjureKit::DomainsCached