| ApiSession Class |
ServerAPI contains the implementation of the WatchDox REST API to be used in the WatchDox Uploader
Inheritance HierarchyNamespace: BlackBerry.Workspaces
Assembly: BlackBerryWorkspacesSDK (in BlackBerryWorkspacesSDK.dll) Version: 7.0.0.223 (7.0.0.223)
SyntaxC#
public class ApiSession : ISessionCallbacks, IDisposable
The ApiSession type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ApiSession |
ApiSession constructor
|
Properties| Name | Description | |
|---|---|---|
 | ActiveEmail |
Get or Set the email address for the currently signed in user
|
| Connected |
Return if connected to the server or not
|
| Connection |
Gets the connection
|
| GlobalDownloadPermission |
Get or Set global download permission
|
| IsUploading |
Get or Set if there is a file being uploaded right now in a thread safe manner
|
| LastUserPlansRefreshTime |
Last user plans refresh time
|
| SentBytes |
Sent bytes
|
| SessionID |
Gets or Sets the Session ID
|
| SignInManager |
SignInManager
|
| SyncDownloadLimit |
Sync download limit
|
| SyncUploadLimit |
Sync upload limit
|
| UploadSpeed |
Upload speed
|
| UserPlan |
Information about user plan
|
Methods| Name | Description | |
|---|---|---|
| BeforeSendingRequest |
BeforeSendRequest event
|
| CaughtSocketException |
Catches socket exception
|
| Dispose |
Dispose
|
| EndSession |
Clear the SessionID value and stop the renewal timer
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| EstablishedConnectionToTheInternet |
Reports wheather connection established to the Internet
|
| GetAuthenticationResource |
Retrieves an instance of an Authentication resource
|
| GetDownloadManager |
Get a new DownloadManager instance.
|
 | GetEmailFromSessionId |
Gets Email from sessionId
|
| GetFilesResource |
Retrieves an instance of a Files resource
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetIManageWorkspacesResource |
Retrieves an instance of a IManageWorkspaces resource
|
| GetItemsResource |
Retrieves an instance of a Items resource
|
| GetNotificationsResource |
Retrieves an instance of a Notifications resource
|
| GetOneDriveManagementResource |
Retrieves an instance of a OneDriveManagement resource
|
| GetOrganizationsResource |
Retrieves an instance of a Organizations resource
|
| GetSearchResource |
Retrieves an instance of a Search resource
|
| GetServerTime |
Gets server time
|
| GetSessionsResource |
Retrieves an instance of a Sessions resource
|
| GetSharePointResource |
Retrieves an instance of a SharePoint resource
|
| GetSystemPropertiesResource |
Retrieves an instance of a SystemProperties resource
|
| GetToken |
Gets auth token
|
| GetTransientWorkspacesResource |
Retrieves an instance of a TransientWorkspaces resource
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUploadManager |
Get a new UploadManager instance.
|
| GetUsersResource |
Retrieves an instance of a Users resource
|
| GetWorkspacesResource |
Retrieves an instance of a Workspaces resource
|
| ListAvailableVDRs |
List available workspaces
|
| LoadExistingSession |
Loads existing session
|
| LogOff |
Attempts to perform the logoff method that corresponds with the sign in type
|
| LostConnectionToTheInternet |
Reports wheather connection lost to the Internet
|
| ReportProxyAuthenticationRequired |
Reports wheather proxy autentication required
|
| SessionIdExpired |
Checks whether session expired
|
| SetNetworkBandwidthLimit |
Sets Network Bandwidth Limit
|
| SetServerTime |
Sets server time
|
| StartSessionWithOAuth |
Sign in against server with given email
|
| StartSessionWithServiceAccount |
Sign in against server with service account
|
| TestConnection |
Actively check Internet connection.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateBytesSent |
Updates bytes sent
|
| UpdateUploadSpeed |
Updates upload speed
|
| WaitForRenewal |
Waits for renewal
|
Events| Name | Description | |
|---|---|---|
 | BeforeSendRequest |
BeforeSendRequest
|
| ConnectionEstablished |
ConnectionEstablished
|
| ConnectionLost |
ConnectionLost
|
| ProxyAuthenticationRequired |
ProxyAuthenticationRequired
|
| SessionExpired |
SessionExpired
|
| SessionSignInInfoChanged |
SessionSignInInfoChanged
|
| SocketExceptionCaught |
SocketExceptionCaught
|
See Also