Class AbstractClient

This class adds the concept of a user to the Client, and couples it with Kinvey.

Inheritance
System.Object
AbstractKinveyClient
AbstractClient
Client
Implements
IDisposable
Inherited Members
Namespace: Kinvey
Assembly: Kinvey.dll
Syntax
public abstract class AbstractClient : AbstractKinveyClient, IDisposable

Constructors

| Improve this Doc View Source

AbstractClient(HttpClient, String, String, KinveyClientRequestInitializer, ICredentialStore)

Initializes a new instance of the AbstractClient class.

Declaration
protected AbstractClient(HttpClient client, string rootUrl, string servicePath, KinveyClientRequestInitializer initializer, ICredentialStore store)
Parameters
Type Name Description
HttpClient client

Client.
System.String rootUrl

Root URL.
System.String servicePath

Service path.
KinveyClientRequestInitializer initializer

Initializer.
ICredentialStore store

Store.

Fields

| Improve this Doc View Source

activeUser

The active user, whose credentials are currently used for authenticating requests.

Declaration
protected User activeUser
Field Value
Type Description
User

Kinvey user.
| Improve this Doc View Source

DefaultBaseUrl

The default base URL.

Declaration
public const string DefaultBaseUrl = null
Field Value
Type Description
System.String

The string value containing default base URL.
| Improve this Doc View Source

DefaultServicePath

The default service path.

Declaration
public const string DefaultServicePath = null
Field Value
Type Description
System.String

The string value containing default service path.
| Improve this Doc View Source

Lock

The access lock.

Declaration
protected object Lock
Field Value
Type Description
System.Object

Lock object.
| Improve this Doc View Source

MICDelegate

The callback for the MIC login, this is used after the redirect.

Declaration
public KinveyDelegate<User> MICDelegate
Field Value
Type Description
KinveyDelegate<User>

The instance of Kinvey delegate.

Properties

| Improve this Doc View Source

ActiveUser

Gets or sets the active user.

Declaration
public virtual User ActiveUser { get; set; }
Property Value
Type Description
User

The active user.
| Improve this Doc View Source

CacheManager

Gets or sets the cache manager, which manages the caches of each DataStore<T>

Declaration
public ICacheManager CacheManager { get; set; }
Property Value
Type Description
ICacheManager

The cache manager
| Improve this Doc View Source

MICApiVersion

Sets the MIC API version. This is relevant in case you need to use a specific version of MIC such as an Early Adopter release.

Declaration
public string MICApiVersion { get; set; }
Property Value
Type Description
System.String

The MICApiVersion property gets/sets the value of the string field, micApiVersion.
| Improve this Doc View Source

MICHostName

Gets or sets the host URL for MIC. The host name for your MIC API. This is relevant if you are using a dedicated instance of Kinvey, with an auth base URL that differs from https://auth.kinvey.com

Declaration
public string MICHostName { get; set; }
Property Value
Type Description
System.String

The MIC host. Your hostname must use "https".
| Improve this Doc View Source

MICRedirectURI

The redirect URI for MIC login requests

Declaration
public string MICRedirectURI { get; set; }
Property Value
Type Description
System.String

The MICRedirectURI property gets/sets the value of the string field, _mICRedirectURI.
| Improve this Doc View Source

NetworkFactory

Gets or sets the network factory, which is used to build requests against the backend.

Declaration
public NetworkFactory NetworkFactory { get; set; }
Property Value
Type Description
NetworkFactory

The network factory
| Improve this Doc View Source

SSOGroupKey

Gets the SSO Group key, used to determine if single sign-on(SSO) is enabled for this app. If a SSO group key is set when the client is built, then SSO is enabled for that org. If not, then the app key is used as the group key, and SSO is disabled.

Declaration
public string SSOGroupKey { get; protected set; }
Property Value
Type Description
System.String

The SSO group key (defaulted to app key).
| Improve this Doc View Source

Store

Gets the credential store.

Declaration
public ICredentialStore Store { get; }
Property Value
Type Description
ICredentialStore

The store.
| Improve this Doc View Source

UserFactory

User request factory, which is used to build requests against the backend.

Declaration
public UserRequestFactory UserFactory { get; set; }
Property Value
Type Description
UserRequestFactory

The UserFactory property gets/sets the value of the UserRequestFactory field, _userFactory.

Methods

| Improve this Doc View Source

CustomEndpoint<I, O>()

Execute custom endpoints

Declaration
public CustomEndpoint<I, O> CustomEndpoint<I, O>()
Returns
Type Description
CustomEndpoint<I, O>

A configured instance of the Custom Endpoint object.
Type Parameters
Name Description
I

The Type of the input.
O

The Type of the output.
| Improve this Doc View Source

Dispose()

Performs all object cleanup, so the garbage collector no longer needs to call the objects Object.Finalize override.

Declaration
public void Dispose()
| Improve this Doc View Source

Dispose(Boolean)

Performs all object cleanup.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Indicates whether the method call comes from a Dispose method (its value is true) or from a finalizer (its value is false).
| Improve this Doc View Source

File()

Access file operations through this.

Declaration
public File File()
Returns
Type Description
File

Kinvey file.
| Improve this Doc View Source

Finalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Declaration
protected void Finalize()
| Improve this Doc View Source

IsUserLoggedIn()

Checks if there is currently a logged in user for this client.

Declaration
public bool IsUserLoggedIn()
Returns
Type Description
System.Boolean

true, if there is a logged in user, false otherwise.

Implements

IDisposable