Namespace Kinvey
Classes
AbstractClient
This class adds the concept of a user to the Client, and couples it with Kinvey.
AbstractClient.Builder
Class which sets up the building of the AbstractClient class.
AbstractDataRequest<T>
AbstractKinveyClient
Base class of the Kinvey Client. Handles setup for making requests to Kinvey backend.
AbstractKinveyClient.Builder
Class which sets up the building of the AbstractKinveyClient class.
AbstractKinveyClientRequest<T>
This is a client request to be sent to Kinvey
AbstractKinveyClientRequest<T>.JSONPayload
The class for the JSON payload.
AbstractKinveyClientRequest<T>.RequestPayloadType
Base class of a request payload type.
AbstractKinveyClientRequest<T>.URLEncodedPayload
The class for the URL encoded payload.
AbstractPush
Base class for pushes.
AbstractPush.EnablePush
This class represents the request for enabling pushes.
AbstractPush.PushPayload
This class represents push payload.
AbstractPush.RemovePush
This class represents the request for disabling pushes.
AccessControlList
JSON represention of the _acl present on every entity stored in Kinvey. This object allows the app to modify with more granularity the access permissions on the entity, which will override the settings at the collection level.
AccessControlList.ACLGroups
Class that holds the list of user groups that can read the entity and the list of user groups that can modify the entity.
AccessToken
This class represents access token.
AndroidNativeCredentialStore
Android native credential store.
AuthLinkCredential
This class represents authentication link credential.
Client
This class is the entry point for access to all of the Kinvey's library features. Use a Client.Builder to create one. Once the Client is created and a user is logged in, all of Kinvey's features can be accessed through their respective accessors. This implementation is thread safe.
Client.Builder
Builder for creating a new instance of a client. Use this class to easily create a new client, as it uses the builder pattern so methods can be chained together.
Once the builder is configured, call .build()
to return an instance of a client.
CollectionTableMap
Represents SQLite table for collection mapping.
Constants
This class provides different constants for SDK.
Credential
This is a credential object, storing authentication information
CredentialManager
This class is used to manage credential objects.
CustomEndpoint<I, O>
Custom endpoint.
CustomEndpointRequest<I, O>
Executes a custom endpoint expecting a single result.
DataStore<T>
Each DataStore in your application represents a collection on your backend. The DataStore class manages the access of data between the Kinvey backend and the app. The DataStore provides simple CRUD operations on data, as well as powerful querying and synchronization APIs.
DataStoreResponse<T>
Class used to capture information about data store operations.
DataStoreType
Store type.
DeltaSetFetchInfo
JSON representation of the fields needed to do delta set comparisons.
DeltaSetResponse<T>
JSON representation of the response from server-side delta set fetch.
Entity
Base class for model objects backed by Kinvey. Implements the IPersistable interface
Error
Represents JSON object with information about an error.
FacebookCredential
This class represents Facebook credential.
FCMPush
FCMPushExtension
File
This class provides access to Kinvey's File API.
FileMetaData
Defines file meta data, storing arbitrary key/value pairs of data associated with a file.
FindAggregateRequest<T>
Find request built in order to apply grouping/aggregation functions to entities within a DataStore<T>
FindRequest<T>
Find request built for use by a DataStore<T>
GetCountRequest<T>
Request built for use by a DataStore<T> to get count of entities.
GoogleCredential
This class represents Google credential.
GroupAggregationResults
JSON representation of the fields return from group aggreation functions
HelperMethods
This class provides logic for different areas of SDK.
HttpBasicAuthenticator
Authenticator for Http basic authentication.
InMemoryCredentialStore
In memory credential store.
KinveyAccountAuthenticator
Kinvey account authenticator.
KinveyAccountService
Kinvey account service.
KinveyAuthenticator
Authenticator for Kinvey style authentication.
KinveyAuthMetaData
Kinvey auth metadata.
KinveyAuthRequest
Kinvey auth request, used for creation/login and setting the session on the client.
KinveyAuthRequest.Builder
Builder for an auth request.
KinveyAuthResponse
This class represents the response of a Kinvey Auth Request.
KinveyAuthSocialID
Kinvey user metadata.
KinveyClientRequestInitializer
The class is for initializing of Kinvey client request.
KinveyDataStoreDelegate<T>
Kinvey data store delegate class is used for the callback pattern when executing requests asynchronously.
KinveyDelegate<T>
The Kinvey Delegate class is used for the callback pattern when executing requests asynchronously. All Async* methods will take one as a parameter.
KinveyDeleteResponse
This class represents the response sent from Kinvey after a delete has been executed.
KinveyException
Wrapper for a Kinvey-specific exception, which contains information about how to resolve the issue.
KinveyFCMService
KinveyFile
JSON representation of the response with Kinvey file data from server-side.
KinveyHeaders
Default Kinvey specific headers added to every request.
KinveyJsonError
Kinvey json error.
KinveyMetaData
JSON representation of the _kmd field present on every entity stored in Kinvey.
KinveyMICDelegate<T>
The class is used for the callback pattern when MIC request has been executed.
KinveyMultiInsertResponse<T>
This class represents a response sent from Kinvey backend after a multi insert operation has been executed.
KinveyQueryable<T>
Kinvey queryable base class. Used to provide access to LINQ queries in order to process them.
KinveyQueryExecutor<K>
Constitutes the bridge between re-linq and a concrete query provider implementation.
KinveyQueryProvider
QueryProvider class.
KinveyRealtimeStatus
Class which represents Kinvey realtime status messages.
KinveyReference<T>
Represents JSON object with information about Kinvey reference.
KinveyUserMetaData
Kinvey user metadata.
KMDEmailVerification
JSON representation of the emailVerification field present on user entities stored in Kinvey that have verified through email
KMDPasswordReset
JSON representation of the emailVerification field present on user entities stored in Kinvey that have verified through email
KMDStatus
JSON representation of the emailVerification field present on user entities stored in Kinvey that have verified through email
LinkedInCredential
This class represents LinkedIn credential.
Logger
The class for logging data.
MICCredential
This class represents MIC credential.
MultiInsertRequest<T>
Represents a multi insert request.
NativeCredential
Native credential.
NativeCredentialStore
Native credential store.
NetworkFactory
The class creates network requests.
NetworkRequest<T>
The class for creating network requests.
OAuth1
This class represents credential for OAuth1.
OAuth2
This class represents credential for OAuth2.
PagedPullRequest<T>
Request built for use by a DataStore<T> to get some count of entities from collection.
PendingWriteAction
Represents SQLite table for pending write action items.
PingResponse
This class represents the response of a ping request.
PreserveAttribute
Instructs a linker to preserve the decorated code
Provider
This class represents the third party identity provider.
PullDataStoreResponse<T>
Class used to capture information about pull data store operations.
PullRequest<T>
Request operation for pulling all records for a collection during a sync, and refreshing the cache with the updated data.
PushDataStoreResponse<T>
Class used to capture information about push data store operations.
PushRequest<T>
Request operation for pushing of data from the library to the backend.
QueryCacheItem
Represents SQLite table for query cache items.
ReadRequest<T, U>
Base class for creating requests to read data.
ReadRequest<T, U>.NetworkReadResponse<T>
This class represents the response of a network read request.
RealtimeMessage<T>
The class represents Kinvey realtime message.
RemoveRequest<T>
Represents a request to remove an entity by id or a list of entities according to query.
Request<T, U>
Base class for network requests.
SalesforceCredential
This class represents salesforce credential.
SaveRequest<T>
Represents a request to save an entity.
SQLiteCache<T>
This is an implementation of an OfflineStore, using SQLite to manage maintaining data. This class is responsible for breaking apart a request, and determing what actions to take Actual actions are performed on the OfflineTable class, using a SQLiteDatabaseHelper
SQLiteCacheManager
SQLite cache manager.
SQLiteCredentialStore
SQLite credential store.
SQLiteSyncQueue
The class implements a synchronization queue.
SQLTemplates
These are the structures stored in the database, one for each table
SQLTemplates.OfflineEntity
This maintains the entities themselves.
SQLTemplates.OfflineMetaData
This maintains the custom request parameters, client app verison, and _id of a queued request
SQLTemplates.QueryItem
This maintains a query and it's responses.
SQLTemplates.QueueItem
This maintains a queue of pending requests.
SQLTemplates.TableItem
This maintains the collection names
StringQueryBuilder
Builds a mongo-style query to be run against the backend.
SubscribeRequest<T>
Subscribe request built for use by a DataStore<T>
SyncDataStoreResponse<T>
Class used to capture information about sync data store operation.
ThirdPartyIdentity
This class represents the third party identity.
TwitterCredential
This class represents Twitter credential.
User
This class manages the state of a Kinvey user. User methods can be accessed through this class, and the active user of an app is an instance of this class. Login methods are implemented as static methods on this class, and will set the active user.
UserDiscovery
The class used to define the parameters for a UserDiscovery lookup
UserExtension
UserRequestFactory
User request factory.
WriteRequest<T, U>
Base class for creating requests to write data.
Interfaces
IAuthenticator
This interface defines the ability to authenticate.
ICache<T>
Interface for the data store cache.
ICacheManager
Interface for cache manager.
ICredentialStore
This interface defines the ability to store Credentials.
IKinveyRequestInitializer
Interface defining ability to initialize a Kinvey request.
IPersistable
Persistable interface which model objects can choose to implement as an alternative to subclassing from Entity
IQueryBuilder
This interface defines the behaivor of building a query.
ISyncQueue
Interface for the synchronization queue.
Enums
Constants.DevicePlatform
EnumErrorCategory
Enumeration for error codes that are client-side errors
EnumErrorCode
Enumeration for error codes that are client-side errors
EnumLoginType
Enumeration for the available login types
EnumReduceFunction
Enumeration for all possible reduce functions used for grouping/aggregation.
EnumUserStatus
Enumeration for user status.
KinveyRealtimeStatus.StatusType
Enum representing all the types of status messages that can be received for realtime.
ReadPolicy
Controls how the library fetches data.
RealtimeReconnectionPolicy
Enumeration for realtime reconnection policy
WritePolicy
Controls how the library saves data.