CircleSDK
SignDataWithUserKeyRequest
Initializes a new instance of the class.
Data.
Data
Data
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if SignDataWithUserKeyRequest instances are equal
Instance of SignDataWithUserKeyRequest to be compared
Boolean
Gets the hash code
Hash code
EnumTopicsReply
Initializes a new instance of the class.
status.
topics.
Gets or Sets Status
Gets or Sets Topics
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumTopicsReply instances are equal
Instance of EnumTopicsReply to be compared
Boolean
Gets the hash code
Hash code
DeleteCircleReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DeleteCircleReply instances are equal
Instance of DeleteCircleReply to be compared
Boolean
Gets the hash code
Hash code
AddMessageReply
Initializes a new instance of the class.
status.
message.
Gets or Sets Status
Gets or Sets Message
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if AddMessageReply instances are equal
Instance of AddMessageReply to be compared
Boolean
Gets the hash code
Hash code
LockUserRequest
Initializes a new instance of the class.
CircleId.
NumberOfCodes.
CircleId
CircleId
NumberOfCodes
NumberOfCodes
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if LockUserRequest instances are equal
Instance of LockUserRequest to be compared
Boolean
Gets the hash code
Hash code
EncryptReply
Initializes a new instance of the class.
status.
EncryptedData.
Gets or Sets Status
EncryptedData
EncryptedData
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EncryptReply instances are equal
Instance of EncryptReply to be compared
Boolean
Gets the hash code
Hash code
GetMessagesReply
Initializes a new instance of the class.
status.
messages.
Gets or Sets Status
Gets or Sets Messages
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetMessagesReply instances are equal
Instance of GetMessagesReply to be compared
Boolean
Gets the hash code
Hash code
EnumCircleMembersRequest
Initializes a new instance of the class.
CircleId.
CircleId
CircleId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumCircleMembersRequest instances are equal
Instance of EnumCircleMembersRequest to be compared
Boolean
Gets the hash code
Hash code
AddMemberToTopicReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if AddMemberToTopicReply instances are equal
Instance of AddMemberToTopicReply to be compared
Boolean
Gets the hash code
Hash code
DefineCircleOfTrustRequest
Initializes a new instance of the class.
CircleId.
CoTPolicyId.
PolicyName.
PolicyDescription.
NumberOfApprovals.
NumberOfRejections.
Timeout.
EncryptionKey.
WebHookURL.
CircleId
CircleId
CoTPolicyId
CoTPolicyId
PolicyName
PolicyName
PolicyDescription
PolicyDescription
NumberOfApprovals
NumberOfApprovals
NumberOfRejections
NumberOfRejections
Timeout
Timeout
EncryptionKey
EncryptionKey
WebHookURL
WebHookURL
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DefineCircleOfTrustRequest instances are equal
Instance of DefineCircleOfTrustRequest to be compared
Boolean
Gets the hash code
Hash code
DenyCoTInvokeRequest
Initializes a new instance of the class.
CircleId.
CoTPolicyId.
CoTInvokeId.
CircleId
CircleId
CoTPolicyId
CoTPolicyId
CoTInvokeId
CoTInvokeId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DenyCoTInvokeRequest instances are equal
Instance of DenyCoTInvokeRequest to be compared
Boolean
Gets the hash code
Hash code
GenInviteReply
Initializes a new instance of the class.
status.
invite.
Gets or Sets Status
Gets or Sets Invite
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GenInviteReply instances are equal
Instance of GenInviteReply to be compared
Boolean
Gets the hash code
Hash code
ProfileInfo
Initializes a new instance of the class.
ProfileId.
UserName.
DisplayName.
ProfileId
ProfileId
UserName
UserName
DisplayName
DisplayName
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if ProfileInfo instances are equal
Instance of ProfileInfo to be compared
Boolean
Gets the hash code
Hash code
EnumTopicMembersReply
Initializes a new instance of the class.
status.
profiles.
Gets or Sets Status
Gets or Sets Profiles
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumTopicMembersReply instances are equal
Instance of EnumTopicMembersReply to be compared
Boolean
Gets the hash code
Hash code
GetSyncStatusReply
Initializes a new instance of the class.
status.
SyncPriority.
SyncState.
CurrentDownloadFileName.
CurrentDownloadFmapID.
CurrentDownloadFileSize.
CurrentDownloadStartedUtc.
CurrentDownloadFileSize.
PeerBytesDownloaded.
PeerFileCountTotal.
PeerFileCountDownloaded.
PeerNonUserAttachmentFileCountTotal.
Gets or Sets Status
SyncPriority
SyncPriority
SyncState
SyncState
CurrentDownloadFileName
CurrentDownloadFileName
CurrentDownloadFmapID
CurrentDownloadFmapID
CurrentDownloadFileSize
CurrentDownloadFileSize
CurrentDownloadStartedUtc
CurrentDownloadStartedUtc
CurrentDownloadFileSize
CurrentDownloadFileSize
PeerBytesDownloaded
PeerBytesDownloaded
PeerFileCountTotal
PeerFileCountTotal
PeerFileCountDownloaded
PeerFileCountDownloaded
PeerNonUserAttachmentFileCountTotal
PeerNonUserAttachmentFileCountTotal
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetSyncStatusReply instances are equal
Instance of GetSyncStatusReply to be compared
Boolean
Gets the hash code
Hash code
EnumTopicsRequest
Initializes a new instance of the class.
CircleId.
CircleId
CircleId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumTopicsRequest instances are equal
Instance of EnumTopicsRequest to be compared
Boolean
Gets the hash code
Hash code
CircleInfo
Initializes a new instance of the class.
CircleId.
CircleName.
CircleDescription.
CreatingProfile.
CreatingDevice.
CircleId
CircleId
CircleName
CircleName
CircleDescription
CircleDescription
CreatingProfile
CreatingProfile
CreatingDevice
CreatingDevice
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if CircleInfo instances are equal
Instance of CircleInfo to be compared
Boolean
Gets the hash code
Hash code
UpdateTopicRequest
Initializes a new instance of the class.
CircleId.
TopicId.
Name.
Description.
CircleId
CircleId
TopicId
TopicId
Name
Name
Description
Description
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if UpdateTopicRequest instances are equal
Instance of UpdateTopicRequest to be compared
Boolean
Gets the hash code
Hash code
ApproveCoTInvokeRequest
Initializes a new instance of the class.
CircleId.
CoTPolicyId.
CoTInvokeId.
CircleId
CircleId
CoTPolicyId
CoTPolicyId
CoTInvokeId
CoTInvokeId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if ApproveCoTInvokeRequest instances are equal
Instance of ApproveCoTInvokeRequest to be compared
Boolean
Gets the hash code
Hash code
BackgroundReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if BackgroundReply instances are equal
Instance of BackgroundReply to be compared
Boolean
Gets the hash code
Hash code
DeleteFileReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DeleteFileReply instances are equal
Instance of DeleteFileReply to be compared
Boolean
Gets the hash code
Hash code
CoTPolicyResult
Initializes a new instance of the class.
Id.
Successful or Failure.
Address.
Id
Id
Successful or Failure
Successful or Failure
Address
Address
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if CoTPolicyResult instances are equal
Instance of CoTPolicyResult to be compared
Boolean
Gets the hash code
Hash code
SignDataWithUserKeyReply
Initializes a new instance of the class.
status.
CurrentDownloadFileName.
Gets or Sets Status
CurrentDownloadFileName
CurrentDownloadFileName
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if SignDataWithUserKeyReply instances are equal
Instance of SignDataWithUserKeyReply to be compared
Boolean
Gets the hash code
Hash code
LockUserReply
Initializes a new instance of the class.
status.
Encrypted UnlockCodes.
results of Circle of Trust.
Gets or Sets Status
Encrypted UnlockCodes
Encrypted UnlockCodes
results of Circle of Trust
results of Circle of Trust
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if LockUserReply instances are equal
Instance of LockUserReply to be compared
Boolean
Gets the hash code
Hash code
SecureFileReply
Initializes a new instance of the class.
status.
SecureFileUrl.
Gets or Sets Status
SecureFileUrl
SecureFileUrl
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if SecureFileReply instances are equal
Instance of SecureFileReply to be compared
Boolean
Gets the hash code
Hash code
LoginWithCircleRequest
Initializes a new instance of the class.
Url.
Url
Url
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if LoginWithCircleRequest instances are equal
Instance of LoginWithCircleRequest to be compared
Boolean
Gets the hash code
Hash code
UnlockUserRequest
Initializes a new instance of the class.
CircleId.
UnlockCodes.
CircleId
CircleId
UnlockCodes
UnlockCodes
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if UnlockUserRequest instances are equal
Instance of UnlockUserRequest to be compared
Boolean
Gets the hash code
Hash code
WhoAmIRequest
Initializes a new instance of the class.
CircleId.
CircleId
CircleId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if WhoAmIRequest instances are equal
Instance of WhoAmIRequest to be compared
Boolean
Gets the hash code
Hash code
SetProfilePropertyReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if SetProfilePropertyReply instances are equal
Instance of SetProfilePropertyReply to be compared
Boolean
Gets the hash code
Hash code
GetCirclePublicKeyRequest
Initializes a new instance of the class.
CircleId.
CircleId
CircleId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetCirclePublicKeyRequest instances are equal
Instance of GetCirclePublicKeyRequest to be compared
Boolean
Gets the hash code
Hash code
DeleteMessageRequest
Initializes a new instance of the class.
CircleId.
MessageId.
CircleId
CircleId
MessageId
MessageId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DeleteMessageRequest instances are equal
Instance of DeleteMessageRequest to be compared
Boolean
Gets the hash code
Hash code
DecryptFileReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DecryptFileReply instances are equal
Instance of DecryptFileReply to be compared
Boolean
Gets the hash code
Hash code
PkiEncryptReply
Initializes a new instance of the class.
status.
EncryptedData.
Gets or Sets Status
EncryptedData
EncryptedData
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if PkiEncryptReply instances are equal
Instance of PkiEncryptReply to be compared
Boolean
Gets the hash code
Hash code
AppAuthorizationRequest
Initializes a new instance of the class.
Token.
Token
Token
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if AppAuthorizationRequest instances are equal
Instance of AppAuthorizationRequest to be compared
Boolean
Gets the hash code
Hash code
JoinTopicRequest
Initializes a new instance of the class.
CircleId.
TopicId.
CircleId
CircleId
TopicId
TopicId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if JoinTopicRequest instances are equal
Instance of JoinTopicRequest to be compared
Boolean
Gets the hash code
Hash code
EnumInvitesReply
Initializes a new instance of the class.
status.
invites.
Gets or Sets Status
Gets or Sets Invites
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumInvitesReply instances are equal
Instance of EnumInvitesReply to be compared
Boolean
Gets the hash code
Hash code
RemoveMemberFromTopicRequest
Initializes a new instance of the class.
CircleId.
TopicId.
MemberId.
CircleId
CircleId
TopicId
TopicId
MemberId
MemberId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if RemoveMemberFromTopicRequest instances are equal
Instance of RemoveMemberFromTopicRequest to be compared
Boolean
Gets the hash code
Hash code
ServiceStatusReply
Initializes a new instance of the class.
status.
UptimeInSeconds.
AppVersion.
BuildVersion.
HasCoT.
OpenCoT.
Gets or Sets Status
UptimeInSeconds
UptimeInSeconds
AppVersion
AppVersion
BuildVersion
BuildVersion
HasCoT
HasCoT
OpenCoT
OpenCoT
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if ServiceStatusReply instances are equal
Instance of ServiceStatusReply to be compared
Boolean
Gets the hash code
Hash code
DenyCoTInvokeReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DenyCoTInvokeReply instances are equal
Instance of DenyCoTInvokeReply to be compared
Boolean
Gets the hash code
Hash code
GetRAVStatusRequest
Initializes a new instance of the class.
RequestAuthVerificationId.
RequestAuthVerificationId
RequestAuthVerificationId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetRAVStatusRequest instances are equal
Instance of GetRAVStatusRequest to be compared
Boolean
Gets the hash code
Hash code
GetSyncStatusRequest
Initializes a new instance of the class.
CircleId.
CircleId
CircleId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetSyncStatusRequest instances are equal
Instance of GetSyncStatusRequest to be compared
Boolean
Gets the hash code
Hash code
SecureFileRequest
Initializes a new instance of the class.
CircleId.
TopicId.
FileUri.
FMapId.
CircleId
CircleId
TopicId
TopicId
FileUri
FileUri
FMapId
FMapId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if SecureFileRequest instances are equal
Instance of SecureFileRequest to be compared
Boolean
Gets the hash code
Hash code
BackgroundRequest
Initializes a new instance of the class.
CircleId.
CircleId
CircleId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if BackgroundRequest instances are equal
Instance of BackgroundRequest to be compared
Boolean
Gets the hash code
Hash code
SignDataWithCircleKeyRequest
Initializes a new instance of the class.
CircleId.
Data.
CircleId
CircleId
Data
Data
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if SignDataWithCircleKeyRequest instances are equal
Instance of SignDataWithCircleKeyRequest to be compared
Boolean
Gets the hash code
Hash code
InviteInfo
Initializes a new instance of the class.
InviteId.
AuthCode.
CreatedSecsSince2000.
ExpiresSecsSince2000.
InviteId
InviteId
AuthCode
AuthCode
CreatedSecsSince2000
CreatedSecsSince2000
ExpiresSecsSince2000
ExpiresSecsSince2000
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if InviteInfo instances are equal
Instance of InviteInfo to be compared
Boolean
Gets the hash code
Hash code
ForegroundRequest
Initializes a new instance of the class.
CircleId.
CircleId
CircleId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if ForegroundRequest instances are equal
Instance of ForegroundRequest to be compared
Boolean
Gets the hash code
Hash code
SignDataWithCircleKeyReply
Initializes a new instance of the class.
status.
CurrentDownloadFileName.
Gets or Sets Status
CurrentDownloadFileName
CurrentDownloadFileName
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if SignDataWithCircleKeyReply instances are equal
Instance of SignDataWithCircleKeyReply to be compared
Boolean
Gets the hash code
Hash code
GetUserPublicKeyReply
Initializes a new instance of the class.
status.
string.
PublicKey.
Gets or Sets Status
string
string
PublicKey
PublicKey
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetUserPublicKeyReply instances are equal
Instance of GetUserPublicKeyReply to be compared
Boolean
Gets the hash code
Hash code
TopicInfo
Initializes a new instance of the class.
TopicId.
TopicName.
TopicDescription.
IsJoined.
IsPrivate.
TopicId
TopicId
TopicName
TopicName
TopicDescription
TopicDescription
IsJoined
IsJoined
IsPrivate
IsPrivate
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if TopicInfo instances are equal
Instance of TopicInfo to be compared
Boolean
Gets the hash code
Hash code
GetMessageReply
Initializes a new instance of the class.
status.
message.
Gets or Sets Status
Gets or Sets Message
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetMessageReply instances are equal
Instance of GetMessageReply to be compared
Boolean
Gets the hash code
Hash code
RemoveMemberFromTopicReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if RemoveMemberFromTopicReply instances are equal
Instance of RemoveMemberFromTopicReply to be compared
Boolean
Gets the hash code
Hash code
ApproveCoTInvokeReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if ApproveCoTInvokeReply instances are equal
Instance of ApproveCoTInvokeReply to be compared
Boolean
Gets the hash code
Hash code
ProcessInviteRequest
Initializes a new instance of the class.
InviteId.
AuthCode.
Wait20Second.
InviteId
InviteId
AuthCode
AuthCode
Wait20Second
Wait20Second
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if ProcessInviteRequest instances are equal
Instance of ProcessInviteRequest to be compared
Boolean
Gets the hash code
Hash code
DeviceInfo
Initializes a new instance of the class.
DeviceId.
DeviceName.
Platform.
IsCurrentDevice.
DeviceId
DeviceId
DeviceName
DeviceName
Platform
Platform
IsCurrentDevice
IsCurrentDevice
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DeviceInfo instances are equal
Instance of DeviceInfo to be compared
Boolean
Gets the hash code
Hash code
LeaveTopicRequest
Initializes a new instance of the class.
CircleId.
TopicId.
CircleId
CircleId
TopicId
TopicId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if LeaveTopicRequest instances are equal
Instance of LeaveTopicRequest to be compared
Boolean
Gets the hash code
Hash code
SetUserIdRequest
Initializes a new instance of the class.
UserId.
UserId
UserId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if SetUserIdRequest instances are equal
Instance of SetUserIdRequest to be compared
Boolean
Gets the hash code
Hash code
EnumKeysReply
Initializes a new instance of the class.
status.
Keys.
Gets or Sets Status
Keys
Keys
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumKeysReply instances are equal
Instance of EnumKeysReply to be compared
Boolean
Gets the hash code
Hash code
GetUserPublicKeyRequest
Initializes a new instance of the class.
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetUserPublicKeyRequest instances are equal
Instance of GetUserPublicKeyRequest to be compared
Boolean
Gets the hash code
Hash code
LogintoServiceRequest
Initializes a new instance of the class.
CircleId.
ServiceId.
InstanceName.
TokenName.
CircleId
CircleId
ServiceId
ServiceId
InstanceName
InstanceName
TokenName
TokenName
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if LogintoServiceRequest instances are equal
Instance of LogintoServiceRequest to be compared
Boolean
Gets the hash code
Hash code
EnumFilesReply
Initializes a new instance of the class.
status.
files.
Gets or Sets Status
Gets or Sets Files
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumFilesReply instances are equal
Instance of EnumFilesReply to be compared
Boolean
Gets the hash code
Hash code
CreateCircleReply
Initializes a new instance of the class.
status.
CircleId.
Gets or Sets Status
CircleId
CircleId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if CreateCircleReply instances are equal
Instance of CreateCircleReply to be compared
Boolean
Gets the hash code
Hash code
StoreTokenRequest
Initializes a new instance of the class.
CircleId.
ServiceId.
TokenName.
TokenJson.
CircleId
CircleId
ServiceId
ServiceId
TokenName
TokenName
TokenJson
TokenJson
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if StoreTokenRequest instances are equal
Instance of StoreTokenRequest to be compared
Boolean
Gets the hash code
Hash code
StoreTokenReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if StoreTokenReply instances are equal
Instance of StoreTokenReply to be compared
Boolean
Gets the hash code
Hash code
EnumCircleMembersReply
Initializes a new instance of the class.
status.
profiles.
Gets or Sets Status
Gets or Sets Profiles
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumCircleMembersReply instances are equal
Instance of EnumCircleMembersReply to be compared
Boolean
Gets the hash code
Hash code
DeleteKeyReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DeleteKeyReply instances are equal
Instance of DeleteKeyReply to be compared
Boolean
Gets the hash code
Hash code
EnumDevicesRequest
Initializes a new instance of the class.
CircleId.
ProfileId.
CircleId
CircleId
ProfileId
ProfileId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumDevicesRequest instances are equal
Instance of EnumDevicesRequest to be compared
Boolean
Gets the hash code
Hash code
SetProfilePropertyRequest
Initializes a new instance of the class.
CircleId (required).
PropertyName (required).
PropertyValue (required).
CircleId
CircleId
PropertyName
PropertyName
PropertyValue
PropertyValue
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if SetProfilePropertyRequest instances are equal
Instance of SetProfilePropertyRequest to be compared
Boolean
Gets the hash code
Hash code
RemoveMemberRequest
Initializes a new instance of the class.
CircleId.
MemberId.
CircleId
CircleId
MemberId
MemberId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if RemoveMemberRequest instances are equal
Instance of RemoveMemberRequest to be compared
Boolean
Gets the hash code
Hash code
RevokeDeviceRequest
Initializes a new instance of the class.
CircleId.
DeviceId.
CircleId
CircleId
DeviceId
DeviceId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if RevokeDeviceRequest instances are equal
Instance of RevokeDeviceRequest to be compared
Boolean
Gets the hash code
Hash code
RemoveMemberReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if RemoveMemberReply instances are equal
Instance of RemoveMemberReply to be compared
Boolean
Gets the hash code
Hash code
SecureContentsRequest
Initializes a new instance of the class.
CircleId.
TopicId.
Contents.
Store.
CircleId
CircleId
TopicId
TopicId
Contents
Contents
Store
Store
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if SecureContentsRequest instances are equal
Instance of SecureContentsRequest to be compared
Boolean
Gets the hash code
Hash code
CreateTopicReply
Initializes a new instance of the class.
status.
TopicId.
Gets or Sets Status
TopicId
TopicId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if CreateTopicReply instances are equal
Instance of CreateTopicReply to be compared
Boolean
Gets the hash code
Hash code
UnlockUserReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if UnlockUserReply instances are equal
Instance of UnlockUserReply to be compared
Boolean
Gets the hash code
Hash code
DownloadFileReply
Initializes a new instance of the class.
status.
fileInfo.
Base64 FileData.
Gets or Sets Status
Gets or Sets FileInfo
Base64 FileData
Base64 FileData
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DownloadFileReply instances are equal
Instance of DownloadFileReply to be compared
Boolean
Gets the hash code
Hash code
AddValueReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if AddValueReply instances are equal
Instance of AddValueReply to be compared
Boolean
Gets the hash code
Hash code
LogintoServiceReply
Initializes a new instance of the class.
status.
ServiceReturn.
Gets or Sets Status
ServiceReturn
ServiceReturn
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if LogintoServiceReply instances are equal
Instance of LogintoServiceReply to be compared
Boolean
Gets the hash code
Hash code
ForegroundReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if ForegroundReply instances are equal
Instance of ForegroundReply to be compared
Boolean
Gets the hash code
Hash code
AddMessageRequest
Initializes a new instance of the class.
CircleId.
TopicId.
MessageType.
MessageSubType.
Message.
Context.
ObjectPath.
Base64Data.
AdditionalJson.
CircleId
CircleId
TopicId
TopicId
MessageType
MessageType
MessageSubType
MessageSubType
Message
Message
Context
Context
ObjectPath
ObjectPath
Base64Data
Base64Data
AdditionalJson
AdditionalJson
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if AddMessageRequest instances are equal
Instance of AddMessageRequest to be compared
Boolean
Gets the hash code
Hash code
ReturnStatus
Initializes a new instance of the class.
Result.
ErrorCode.
Message.
Result
Result
ErrorCode
ErrorCode
Message
Message
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if ReturnStatus instances are equal
Instance of ReturnStatus to be compared
Boolean
Gets the hash code
Hash code
SetUserIdReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if SetUserIdReply instances are equal
Instance of SetUserIdReply to be compared
Boolean
Gets the hash code
Hash code
DefineCircleOfTrustReply
Initializes a new instance of the class.
status.
CoTPolicyId.
Gets or Sets Status
CoTPolicyId
CoTPolicyId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DefineCircleOfTrustReply instances are equal
Instance of DefineCircleOfTrustReply to be compared
Boolean
Gets the hash code
Hash code
EnumKeysRequest
Initializes a new instance of the class.
CircleId.
TopicId.
MultiDeviceSupport.
CircleId
CircleId
TopicId
TopicId
MultiDeviceSupport
MultiDeviceSupport
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumKeysRequest instances are equal
Instance of EnumKeysRequest to be compared
Boolean
Gets the hash code
Hash code
EnumTopicMembersRequest
Initializes a new instance of the class.
CircleId.
TopicId.
CircleId
CircleId
TopicId
TopicId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumTopicMembersRequest instances are equal
Instance of EnumTopicMembersRequest to be compared
Boolean
Gets the hash code
Hash code
PkiDecryptRequest
Initializes a new instance of the class.
EncryptedData (required).
EncryptedData
EncryptedData
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if PkiDecryptRequest instances are equal
Instance of PkiDecryptRequest to be compared
Boolean
Gets the hash code
Hash code
DecryptRequest
Initializes a new instance of the class.
CircleId.
TopicId.
ToDecrypt.
CircleId
CircleId
TopicId
TopicId
ToDecrypt
ToDecrypt
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DecryptRequest instances are equal
Instance of DecryptRequest to be compared
Boolean
Gets the hash code
Hash code
AppAuthorizationReply
Initializes a new instance of the class.
status.
Token.
Gets or Sets Status
Token
Token
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if AppAuthorizationReply instances are equal
Instance of AppAuthorizationReply to be compared
Boolean
Gets the hash code
Hash code
LeaveTopicReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if LeaveTopicReply instances are equal
Instance of LeaveTopicReply to be compared
Boolean
Gets the hash code
Hash code
AddValueRequest
Initializes a new instance of the class.
CircleId.
TopicId.
KeyName.
Value.
CircleId
CircleId
TopicId
TopicId
KeyName
KeyName
Value
Value
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if AddValueRequest instances are equal
Instance of AddValueRequest to be compared
Boolean
Gets the hash code
Hash code
UpdateTopicReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if UpdateTopicReply instances are equal
Instance of UpdateTopicReply to be compared
Boolean
Gets the hash code
Hash code
UploadFileRequest
Initializes a new instance of the class.
CircleId.
TopicId.
FileName.
Description.
Description.
CircleId
CircleId
TopicId
TopicId
FileName
FileName
Description
Description
Description
Description
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if UploadFileRequest instances are equal
Instance of UploadFileRequest to be compared
Boolean
Gets the hash code
Hash code
DeleteFileRequest
Initializes a new instance of the class.
CircleId.
FmapId.
CircleId
CircleId
FmapId
FmapId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DeleteFileRequest instances are equal
Instance of DeleteFileRequest to be compared
Boolean
Gets the hash code
Hash code
ProcessInviteReply
Initializes a new instance of the class.
status.
RequestAuthVerificationId.
Gets or Sets Status
RequestAuthVerificationId
RequestAuthVerificationId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if ProcessInviteReply instances are equal
Instance of ProcessInviteReply to be compared
Boolean
Gets the hash code
Hash code
ServiceStatusRequest
Initializes a new instance of the class.
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if ServiceStatusRequest instances are equal
Instance of ServiceStatusRequest to be compared
Boolean
Gets the hash code
Hash code
DecryptReply
Initializes a new instance of the class.
status.
DecryptedData.
FileName.
Gets or Sets Status
DecryptedData
DecryptedData
FileName
FileName
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DecryptReply instances are equal
Instance of DecryptReply to be compared
Boolean
Gets the hash code
Hash code
EnumFilesRequest
Initializes a new instance of the class.
CircleId.
TopicId.
CircleId
CircleId
TopicId
TopicId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumFilesRequest instances are equal
Instance of EnumFilesRequest to be compared
Boolean
Gets the hash code
Hash code
EnumInvitesRequest
Initializes a new instance of the class.
CircleId.
CircleId
CircleId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumInvitesRequest instances are equal
Instance of EnumInvitesRequest to be compared
Boolean
Gets the hash code
Hash code
DecryptFileRequest
Initializes a new instance of the class.
CircleId.
TopicId.
InFilePath.
OutFilePath.
CircleId
CircleId
TopicId
TopicId
InFilePath
InFilePath
OutFilePath
OutFilePath
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DecryptFileRequest instances are equal
Instance of DecryptFileRequest to be compared
Boolean
Gets the hash code
Hash code
SecureContentsReply
Initializes a new instance of the class.
status.
SecureContentsData.
SecureFileUrl.
Gets or Sets Status
SecureContentsData
SecureContentsData
SecureFileUrl
SecureFileUrl
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if SecureContentsReply instances are equal
Instance of SecureContentsReply to be compared
Boolean
Gets the hash code
Hash code
JoinTopicReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if JoinTopicReply instances are equal
Instance of JoinTopicReply to be compared
Boolean
Gets the hash code
Hash code
FileInfo
Initializes a new instance of the class.
FileName.
RevisionNumber.
FileSize.
FmapId.
OwnerId.
Uploaded.
FileName
FileName
RevisionNumber
RevisionNumber
FileSize
FileSize
FmapId
FmapId
OwnerId
OwnerId
Uploaded
Uploaded
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if FileInfo instances are equal
Instance of FileInfo to be compared
Boolean
Gets the hash code
Hash code
EncryptRequest
Initializes a new instance of the class.
CircleId.
TopicId.
ToEncrypt base64 data.
FileName stored in the encrypted header so we can know the type of file it is.
CircleId
CircleId
TopicId
TopicId
ToEncrypt base64 data
ToEncrypt base64 data
FileName stored in the encrypted header so we can know the type of file it is
FileName stored in the encrypted header so we can know the type of file it is
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EncryptRequest instances are equal
Instance of EncryptRequest to be compared
Boolean
Gets the hash code
Hash code
PkiEncryptRequest
Initializes a new instance of the class.
ToEncrypt.
ToEncrypt
ToEncrypt
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if PkiEncryptRequest instances are equal
Instance of PkiEncryptRequest to be compared
Boolean
Gets the hash code
Hash code
AddMemberToTopicRequest
Initializes a new instance of the class.
CircleId.
TopicId.
MemberId.
CircleId
CircleId
TopicId
TopicId
MemberId
MemberId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if AddMemberToTopicRequest instances are equal
Instance of AddMemberToTopicRequest to be compared
Boolean
Gets the hash code
Hash code
GetValueReply
Initializes a new instance of the class.
status.
Value.
Gets or Sets Status
Value
Value
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetValueReply instances are equal
Instance of GetValueReply to be compared
Boolean
Gets the hash code
Hash code
GetSecureFileContentsReply
Initializes a new instance of the class.
status.
secureFileInfo.
FileData.
Gets or Sets Status
Gets or Sets SecureFileInfo
FileData
FileData
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetSecureFileContentsReply instances are equal
Instance of GetSecureFileContentsReply to be compared
Boolean
Gets the hash code
Hash code
CreateCircleRequest
Initializes a new instance of the class.
CircleName.
CircleDescription.
CustomerId.
CustomerToken.
CircleName
CircleName
CircleDescription
CircleDescription
CustomerId
CustomerId
CustomerToken
CustomerToken
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if CreateCircleRequest instances are equal
Instance of CreateCircleRequest to be compared
Boolean
Gets the hash code
Hash code
GetCirclePublicKeyReply
Initializes a new instance of the class.
status.
PublicKey.
Gets or Sets Status
PublicKey
PublicKey
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetCirclePublicKeyReply instances are equal
Instance of GetCirclePublicKeyReply to be compared
Boolean
Gets the hash code
Hash code
LoginWithCircleReply
Initializes a new instance of the class.
status.
RedirUrl.
Gets or Sets Status
RedirUrl
RedirUrl
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if LoginWithCircleReply instances are equal
Instance of LoginWithCircleReply to be compared
Boolean
Gets the hash code
Hash code
WhoAmIReply
Initializes a new instance of the class.
status.
MemberId.
devices.
if the user is locked or not.
Gets or Sets Status
MemberId
MemberId
Gets or Sets Devices
if the user is locked or not
if the user is locked or not
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if WhoAmIReply instances are equal
Instance of WhoAmIReply to be compared
Boolean
Gets the hash code
Hash code
DeleteMessageReply
Initializes a new instance of the class.
status.
message.
Gets or Sets Status
Gets or Sets Message
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DeleteMessageReply instances are equal
Instance of DeleteMessageReply to be compared
Boolean
Gets the hash code
Hash code
DeleteCircleRequest
Initializes a new instance of the class.
CircleId.
CircleId
CircleId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DeleteCircleRequest instances are equal
Instance of DeleteCircleRequest to be compared
Boolean
Gets the hash code
Hash code
ConfigureServiceRequest
Initializes a new instance of the class.
CircleId.
ServiceId.
InstanceName.
ServiceConfigurationJson.
CircleId
CircleId
ServiceId
ServiceId
InstanceName
InstanceName
ServiceConfigurationJson
ServiceConfigurationJson
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if ConfigureServiceRequest instances are equal
Instance of ConfigureServiceRequest to be compared
Boolean
Gets the hash code
Hash code
EnumCirclesRequest
Initializes a new instance of the class.
CustomerCode.
CustomerCode
CustomerCode
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumCirclesRequest instances are equal
Instance of EnumCirclesRequest to be compared
Boolean
Gets the hash code
Hash code
GenInviteRequest
Initializes a new instance of the class.
CircleId.
IsAddDevice.
CircleId
CircleId
IsAddDevice
IsAddDevice
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GenInviteRequest instances are equal
Instance of GenInviteRequest to be compared
Boolean
Gets the hash code
Hash code
GetValueRequest
Initializes a new instance of the class.
CircleId.
TopicId.
KeyName.
MultiDeviceSupport.
CircleId
CircleId
TopicId
TopicId
KeyName
KeyName
MultiDeviceSupport
MultiDeviceSupport
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetValueRequest instances are equal
Instance of GetValueRequest to be compared
Boolean
Gets the hash code
Hash code
EnumCirclesReply
Initializes a new instance of the class.
status.
circleMeta.
Gets or Sets Status
Gets or Sets CircleMeta
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumCirclesReply instances are equal
Instance of EnumCirclesReply to be compared
Boolean
Gets the hash code
Hash code
RenameFileRequest
Initializes a new instance of the class.
CircleId.
FmapId.
NewFilename.
CircleId
CircleId
FmapId
FmapId
NewFilename
NewFilename
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if RenameFileRequest instances are equal
Instance of RenameFileRequest to be compared
Boolean
Gets the hash code
Hash code
DeleteKeyRequest
Initializes a new instance of the class.
CircleId.
TopicId.
KeyName.
CircleId
CircleId
TopicId
TopicId
KeyName
KeyName
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DeleteKeyRequest instances are equal
Instance of DeleteKeyRequest to be compared
Boolean
Gets the hash code
Hash code
GetRAVStatusReply
Initializes a new instance of the class.
status.
RequestAuthVerificationId.
EventTimeSecsSince2000.
Verifier.
RAVStatus.
Details.
CircleId.
CustomerId.
Gets or Sets Status
RequestAuthVerificationId
RequestAuthVerificationId
EventTimeSecsSince2000
EventTimeSecsSince2000
Verifier
Verifier
RAVStatus
RAVStatus
Details
Details
CircleId
CircleId
CustomerId
CustomerId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetRAVStatusReply instances are equal
Instance of GetRAVStatusReply to be compared
Boolean
Gets the hash code
Hash code
GetMessagesRequest
Initializes a new instance of the class.
CircleId.
TopicId.
MsgTypeFilters.
SubTypeFilters.
CircleId
CircleId
TopicId
TopicId
MsgTypeFilters
MsgTypeFilters
SubTypeFilters
SubTypeFilters
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetMessagesRequest instances are equal
Instance of GetMessagesRequest to be compared
Boolean
Gets the hash code
Hash code
MessageInfo
Initializes a new instance of the class.
MessageId.
UserId.
MessageTimeOffset.
Message.
MessageType.
MessageSubType.
Context.
ObjectPath.
Base64Data.
AdditionalJson.
MessageId
MessageId
UserId
UserId
MessageTimeOffset
MessageTimeOffset
Message
Message
MessageType
MessageType
MessageSubType
MessageSubType
Context
Context
ObjectPath
ObjectPath
Base64Data
Base64Data
AdditionalJson
AdditionalJson
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if MessageInfo instances are equal
Instance of MessageInfo to be compared
Boolean
Gets the hash code
Hash code
EnumDevicesReply
Initializes a new instance of the class.
status.
devices.
Gets or Sets Status
Gets or Sets Devices
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumDevicesReply instances are equal
Instance of EnumDevicesReply to be compared
Boolean
Gets the hash code
Hash code
GetCircleOfTrustReply
Initializes a new instance of the class.
status.
PolicyName.
PolicyDescription.
NumberOfApprovals.
NumberOfRejections.
Timeout.
EncryptionKey.
WebHookURL.
Gets or Sets Status
PolicyName
PolicyName
PolicyDescription
PolicyDescription
NumberOfApprovals
NumberOfApprovals
NumberOfRejections
NumberOfRejections
Timeout
Timeout
EncryptionKey
EncryptionKey
WebHookURL
WebHookURL
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetCircleOfTrustReply instances are equal
Instance of GetCircleOfTrustReply to be compared
Boolean
Gets the hash code
Hash code
DownloadFileRequest
Initializes a new instance of the class.
CircleId.
FmapId.
CircleId
CircleId
FmapId
FmapId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if DownloadFileRequest instances are equal
Instance of DownloadFileRequest to be compared
Boolean
Gets the hash code
Hash code
RevokeDeviceReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if RevokeDeviceReply instances are equal
Instance of RevokeDeviceReply to be compared
Boolean
Gets the hash code
Hash code
CreateTopicRequest
Initializes a new instance of the class.
CircleId.
TopicName.
TopicDescription.
IsPrivate.
CircleId
CircleId
TopicName
TopicName
TopicDescription
TopicDescription
IsPrivate
IsPrivate
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if CreateTopicRequest instances are equal
Instance of CreateTopicRequest to be compared
Boolean
Gets the hash code
Hash code
GetSecureFileContentsRequest
Initializes a new instance of the class.
SecureFileData.
FileUri.
SecureFileData
SecureFileData
FileUri
FileUri
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetSecureFileContentsRequest instances are equal
Instance of GetSecureFileContentsRequest to be compared
Boolean
Gets the hash code
Hash code
ConfigureServiceReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if ConfigureServiceReply instances are equal
Instance of ConfigureServiceReply to be compared
Boolean
Gets the hash code
Hash code
RevokeInviteReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if RevokeInviteReply instances are equal
Instance of RevokeInviteReply to be compared
Boolean
Gets the hash code
Hash code
EnumRevisionsRequest
Initializes a new instance of the class.
CircleId.
FmapId.
CircleId
CircleId
FmapId
FmapId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumRevisionsRequest instances are equal
Instance of EnumRevisionsRequest to be compared
Boolean
Gets the hash code
Hash code
RevokeInviteRequest
Initializes a new instance of the class.
CircleId.
InviteId.
CircleId
CircleId
InviteId
InviteId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if RevokeInviteRequest instances are equal
Instance of RevokeInviteRequest to be compared
Boolean
Gets the hash code
Hash code
RenameFileReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if RenameFileReply instances are equal
Instance of RenameFileReply to be compared
Boolean
Gets the hash code
Hash code
EnumRevisionsReply
Initializes a new instance of the class.
status.
files.
Gets or Sets Status
Gets or Sets Files
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if EnumRevisionsReply instances are equal
Instance of EnumRevisionsReply to be compared
Boolean
Gets the hash code
Hash code
GetMessageRequest
Initializes a new instance of the class.
CircleId.
MessageId.
CircleId
CircleId
MessageId
MessageId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetMessageRequest instances are equal
Instance of GetMessageRequest to be compared
Boolean
Gets the hash code
Hash code
PkiDecryptReply
Initializes a new instance of the class.
status.
DecryptedData.
Gets or Sets Status
DecryptedData
DecryptedData
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if PkiDecryptReply instances are equal
Instance of PkiDecryptReply to be compared
Boolean
Gets the hash code
Hash code
UploadFileReply
Initializes a new instance of the class.
status.
Gets or Sets Status
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if UploadFileReply instances are equal
Instance of UploadFileReply to be compared
Boolean
Gets the hash code
Hash code
GetCircleOfTrustRequest
Initializes a new instance of the class.
CircleId.
CoTPolicyId.
CircleId
CircleId
CoTPolicyId
CoTPolicyId
Returns the string presentation of the object
String presentation of the object
Returns the JSON string presentation of the object
JSON string presentation of the object
Returns true if objects are equal
Object to be compared
Boolean
Returns true if GetCircleOfTrustRequest instances are equal
Instance of GetCircleOfTrustRequest to be compared
Boolean
Gets the hash code
Hash code
Represents a collection of functions to interact with the API endpoints
addMemberToTopic
Add a Member to a Topic. Unlike the case with Circles, you add a Member to a Topic directly (no Invite-and-Accept is required).
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
AddMemberToTopicReply
addMemberToTopic
Add a Member to a Topic. Unlike the case with Circles, you add a Member to a Topic directly (no Invite-and-Accept is required).
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of AddMemberToTopicReply
addMessage
Adds a message to the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
AddMessageReply
addMessage
Adds a message to the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of AddMessageReply
addValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
AddValueReply
addValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of AddValueReply
ApproveCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApproveCoTInvokeReply
ApproveCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of ApproveCoTInvokeReply
authorize
Authorizes use of the CircleService
Thrown when fails to make API call
Application `appKey`
AppAuthorizationReply
authorize
Authorizes use of the CircleService
Thrown when fails to make API call
Application `appKey`
ApiResponse of AppAuthorizationReply
background
Sets the sync status for a Circle to Background, permitting delayed file sync and slower real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
BackgroundReply
background
Sets the sync status for a Circle to Background, permitting delayed file sync and slower real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of BackgroundReply
configureService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
ConfigureServiceReply
configureService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
ApiResponse of ConfigureServiceReply
createCircle
Creates a Circle. Initially the current device is the only member of the new Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
CreateCircleReply
createCircle
Creates a Circle. Initially the current device is the only member of the new Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of CreateCircleReply
createTopic
Create a new Topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
CreateTopicReply
createTopic
Create a new Topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of CreateTopicReply
decrypt
Decrypt base64 data using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
DecryptReply
decrypt
Decrypt base64 data using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
ApiResponse of DecryptReply
DefineCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DefineCircleOfTrustReply
DefineCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DefineCircleOfTrustReply
DeleteCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DeleteCircleReply
DeleteCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DeleteCircleReply
deleteFile
The Circle ID and the FileMap ID for the file you want to delete.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DeleteFileReply
deleteFile
The Circle ID and the FileMap ID for the file you want to delete.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DeleteFileReply
deleteKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DeleteKeyReply
deleteKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DeleteKeyReply
DeleteMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DeleteMessageReply
DeleteMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DeleteMessageReply
DenyCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DenyCoTInvokeReply
DenyCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DenyCoTInvokeReply
downloadFile
Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DownloadFileReply
downloadFile
Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DownloadFileReply
encrypt
Encrypts base64 using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
EncryptReply
encrypt
Encrypts base64 using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
ApiResponse of EncryptReply
enumCircleMembers
Enumerates all the members in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumCircleMembersReply
enumCircleMembers
Enumerates all the members in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumCircleMembersReply
enumCircles
Enumerates (lists) Circles to which the current device belongs. The Circle engine does discovery in a background thread; as a result, this list is 'best effort,' especially right after startup. Can return a subset of Circles while it’s still in discovery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumCirclesReply
enumCircles
Enumerates (lists) Circles to which the current device belongs. The Circle engine does discovery in a background thread; as a result, this list is 'best effort,' especially right after startup. Can return a subset of Circles while it’s still in discovery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumCirclesReply
enumDevices
Enumerates all of the devices associated with a Member.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumDevicesReply
enumDevices
Enumerates all of the devices associated with a Member.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumDevicesReply
enumFiles
Enumerates (lists) all the Files within a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumFilesReply
enumFiles
Enumerates (lists) all the Files within a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumFilesReply
enumInvites
Enumerates (lists) the invites currently pending for the Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumInvitesReply
enumInvites
Enumerates (lists) the invites currently pending for the Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumInvitesReply
enumKeys
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumKeysReply
enumKeys
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumKeysReply
enumRevisions
Enumerates (lists) all of the revisions of a file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumRevisionsReply
enumRevisions
Enumerates (lists) all of the revisions of a file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumRevisionsReply
enumTopicMembers
Enumerates the list of members in the specified topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumTopicMembersReply
enumTopicMembers
Enumerates the list of members in the specified topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumTopicMembersReply
enumTopics
Enumerates (lists) the Topics in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumTopicsReply
enumTopics
Enumerates (lists) the Topics in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumTopicsReply
foreground
Sets the sync status for a Circle to Foreground, enabling faster file sync and minimal delay in real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ForegroundReply
foreground
Sets the sync status for a Circle to Foreground, enabling faster file sync and minimal delay in real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of ForegroundReply
genInvite
Generates the invitation ID and authorization code for a Circle invitation.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GenInviteReply
genInvite
Generates the invitation ID and authorization code for a Circle invitation.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GenInviteReply
GetCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetCircleOfTrustReply
GetCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetCircleOfTrustReply
GetCirclePublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetCirclePublicKeyReply
GetCirclePublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetCirclePublicKeyReply
GetMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetMessageReply
GetMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetMessageReply
getMessages
Gets the messages from the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetMessagesReply
getMessages
Gets the messages from the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetMessagesReply
GetRAVStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetRAVStatusReply
GetRAVStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetRAVStatusReply
GetSecureFileContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetSecureFileContentsReply
GetSecureFileContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetSecureFileContentsReply
getSyncStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetSyncStatusReply
getSyncStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetSyncStatusReply
GetUserPublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetUserPublicKeyReply
GetUserPublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetUserPublicKeyReply
getValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetValueReply
getValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetValueReply
joinTopic
Joins an existing topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
JoinTopicReply
joinTopic
Joins an existing topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of JoinTopicReply
leaveTopic
Leave ('unjoin') a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
LeaveTopicReply
leaveTopic
Leave ('unjoin') a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of LeaveTopicReply
lockUser
Lock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
LockUserReply
lockUser
Lock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of LockUserReply
LoginWithCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
LoginWithCircleReply
LoginWithCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of LoginWithCircleReply
logintoService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
LogintoServiceReply
logintoService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
ApiResponse of LogintoServiceReply
PkiDecrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
PkiDecryptReply
PkiDecrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of PkiDecryptReply
PkiEncrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
PkiEncryptReply
PkiEncrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of PkiEncryptReply
processInvite
Offer an Invite to a device. Generate the Invite first using GenInvite(). An Invite is valid until it is accepted or until it fails five times. An Invite can also time out, which happens after one week.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ProcessInviteReply
processInvite
Offer an Invite to a device. Generate the Invite first using GenInvite(). An Invite is valid until it is accepted or until it fails five times. An Invite can also time out, which happens after one week.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of ProcessInviteReply
removeMember
Removes a member from a Circle. Can be used to remove yourself.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
RemoveMemberReply
removeMember
Removes a member from a Circle. Can be used to remove yourself.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of RemoveMemberReply
removeMemberFromTopic
Remove a Member from a Topic. The Member is removed immediately from the current device, but may take a short time to propagate to other devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
RemoveMemberFromTopicReply
removeMemberFromTopic
Remove a Member from a Topic. The Member is removed immediately from the current device, but may take a short time to propagate to other devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of RemoveMemberFromTopicReply
renameFile
Renames the desired file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
RenameFileReply
renameFile
Renames the desired file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of RenameFileReply
revokeDevice
Removes and wipes a device from the intended Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
RevokeDeviceReply
revokeDevice
Removes and wipes a device from the intended Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of RevokeDeviceReply
revokeInvite
Removes a pending invitation to a Circle. If the Invite has been accepted, use RevokeDevice() instead.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
RevokeInviteReply
revokeInvite
Removes a pending invitation to a Circle. If the Invite has been accepted, use RevokeDevice() instead.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of RevokeInviteReply
SecureContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
SecureContentsReply
SecureContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of SecureContentsReply
SecureFile
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
SecureFileReply
SecureFile
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of SecureFileReply
serviceStatus
Thrown when fails to make API call
ServiceStatusReply
serviceStatus
Thrown when fails to make API call
ApiResponse of ServiceStatusReply
SetProfileProperty
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
SetProfilePropertyReply
SetProfileProperty
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of SetProfilePropertyReply
SetUserId
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
SetUserIdReply
SetUserId
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of SetUserIdReply
SignDataWithCircleKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
SignDataWithCircleKeyReply
SignDataWithCircleKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of SignDataWithCircleKeyReply
SignDataWithUserKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
SignDataWithUserKeyReply
SignDataWithUserKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of SignDataWithUserKeyReply
storeToken
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
StoreTokenReply
storeToken
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
ApiResponse of StoreTokenReply
unlockUser
Unlock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
UnlockUserReply
unlockUser
Unlock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of UnlockUserReply
updateTopic
Updates the name and description of an existing topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
UpdateTopicReply
updateTopic
Updates the name and description of an existing topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of UpdateTopicReply
uploadFile
Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
UploadFileReply
uploadFile
Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of UploadFileReply
whoAmI
Provides the member ID and the list of the member’s joined devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
WhoAmIReply
whoAmI
Provides the member ID and the list of the member’s joined devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of WhoAmIReply
addMemberToTopic
Add a Member to a Topic. Unlike the case with Circles, you add a Member to a Topic directly (no Invite-and-Accept is required).
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of AddMemberToTopicReply
addMemberToTopic
Add a Member to a Topic. Unlike the case with Circles, you add a Member to a Topic directly (no Invite-and-Accept is required).
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (AddMemberToTopicReply)
addMessage
Adds a message to the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of AddMessageReply
addMessage
Adds a message to the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (AddMessageReply)
addValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of AddValueReply
addValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (AddValueReply)
ApproveCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApproveCoTInvokeReply
ApproveCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (ApproveCoTInvokeReply)
authorize
Authorizes use of the CircleService
Thrown when fails to make API call
Application `appKey`
Task of AppAuthorizationReply
authorize
Authorizes use of the CircleService
Thrown when fails to make API call
Application `appKey`
Task of ApiResponse (AppAuthorizationReply)
background
Sets the sync status for a Circle to Background, permitting delayed file sync and slower real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of BackgroundReply
background
Sets the sync status for a Circle to Background, permitting delayed file sync and slower real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (BackgroundReply)
configureService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of ConfigureServiceReply
configureService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of ApiResponse (ConfigureServiceReply)
createCircle
Creates a Circle. Initially the current device is the only member of the new Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of CreateCircleReply
createCircle
Creates a Circle. Initially the current device is the only member of the new Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (CreateCircleReply)
createTopic
Create a new Topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of CreateTopicReply
createTopic
Create a new Topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (CreateTopicReply)
decrypt
Decrypt base64 data using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of DecryptReply
decrypt
Decrypt base64 data using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of ApiResponse (DecryptReply)
DefineCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DefineCircleOfTrustReply
DefineCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DefineCircleOfTrustReply)
DeleteCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DeleteCircleReply
DeleteCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DeleteCircleReply)
deleteFile
The Circle ID and the FileMap ID for the file you want to delete.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DeleteFileReply
deleteFile
The Circle ID and the FileMap ID for the file you want to delete.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DeleteFileReply)
deleteKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DeleteKeyReply
deleteKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DeleteKeyReply)
DeleteMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DeleteMessageReply
DeleteMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DeleteMessageReply)
DenyCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DenyCoTInvokeReply
DenyCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DenyCoTInvokeReply)
downloadFile
Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DownloadFileReply
downloadFile
Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DownloadFileReply)
encrypt
Encrypts base64 using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of EncryptReply
encrypt
Encrypts base64 using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of ApiResponse (EncryptReply)
enumCircleMembers
Enumerates all the members in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumCircleMembersReply
enumCircleMembers
Enumerates all the members in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumCircleMembersReply)
enumCircles
Enumerates (lists) Circles to which the current device belongs. The Circle engine does discovery in a background thread; as a result, this list is 'best effort,' especially right after startup. Can return a subset of Circles while it’s still in discovery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumCirclesReply
enumCircles
Enumerates (lists) Circles to which the current device belongs. The Circle engine does discovery in a background thread; as a result, this list is 'best effort,' especially right after startup. Can return a subset of Circles while it’s still in discovery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumCirclesReply)
enumDevices
Enumerates all of the devices associated with a Member.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumDevicesReply
enumDevices
Enumerates all of the devices associated with a Member.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumDevicesReply)
enumFiles
Enumerates (lists) all the Files within a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumFilesReply
enumFiles
Enumerates (lists) all the Files within a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumFilesReply)
enumInvites
Enumerates (lists) the invites currently pending for the Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumInvitesReply
enumInvites
Enumerates (lists) the invites currently pending for the Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumInvitesReply)
enumKeys
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumKeysReply
enumKeys
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumKeysReply)
enumRevisions
Enumerates (lists) all of the revisions of a file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumRevisionsReply
enumRevisions
Enumerates (lists) all of the revisions of a file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumRevisionsReply)
enumTopicMembers
Enumerates the list of members in the specified topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumTopicMembersReply
enumTopicMembers
Enumerates the list of members in the specified topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumTopicMembersReply)
enumTopics
Enumerates (lists) the Topics in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumTopicsReply
enumTopics
Enumerates (lists) the Topics in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumTopicsReply)
foreground
Sets the sync status for a Circle to Foreground, enabling faster file sync and minimal delay in real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ForegroundReply
foreground
Sets the sync status for a Circle to Foreground, enabling faster file sync and minimal delay in real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (ForegroundReply)
genInvite
Generates the invitation ID and authorization code for a Circle invitation.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GenInviteReply
genInvite
Generates the invitation ID and authorization code for a Circle invitation.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GenInviteReply)
GetCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetCircleOfTrustReply
GetCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetCircleOfTrustReply)
GetCirclePublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetCirclePublicKeyReply
GetCirclePublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetCirclePublicKeyReply)
GetMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetMessageReply
GetMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetMessageReply)
getMessages
Gets the messages from the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetMessagesReply
getMessages
Gets the messages from the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetMessagesReply)
GetRAVStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetRAVStatusReply
GetRAVStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetRAVStatusReply)
GetSecureFileContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetSecureFileContentsReply
GetSecureFileContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetSecureFileContentsReply)
getSyncStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetSyncStatusReply
getSyncStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetSyncStatusReply)
GetUserPublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetUserPublicKeyReply
GetUserPublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetUserPublicKeyReply)
getValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetValueReply
getValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetValueReply)
joinTopic
Joins an existing topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of JoinTopicReply
joinTopic
Joins an existing topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (JoinTopicReply)
leaveTopic
Leave ('unjoin') a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of LeaveTopicReply
leaveTopic
Leave ('unjoin') a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (LeaveTopicReply)
lockUser
Lock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of LockUserReply
lockUser
Lock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (LockUserReply)
LoginWithCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of LoginWithCircleReply
LoginWithCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (LoginWithCircleReply)
logintoService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of LogintoServiceReply
logintoService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of ApiResponse (LogintoServiceReply)
PkiDecrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of PkiDecryptReply
PkiDecrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (PkiDecryptReply)
PkiEncrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of PkiEncryptReply
PkiEncrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (PkiEncryptReply)
processInvite
Offer an Invite to a device. Generate the Invite first using GenInvite(). An Invite is valid until it is accepted or until it fails five times. An Invite can also time out, which happens after one week.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ProcessInviteReply
processInvite
Offer an Invite to a device. Generate the Invite first using GenInvite(). An Invite is valid until it is accepted or until it fails five times. An Invite can also time out, which happens after one week.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (ProcessInviteReply)
removeMember
Removes a member from a Circle. Can be used to remove yourself.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of RemoveMemberReply
removeMember
Removes a member from a Circle. Can be used to remove yourself.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (RemoveMemberReply)
removeMemberFromTopic
Remove a Member from a Topic. The Member is removed immediately from the current device, but may take a short time to propagate to other devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of RemoveMemberFromTopicReply
removeMemberFromTopic
Remove a Member from a Topic. The Member is removed immediately from the current device, but may take a short time to propagate to other devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (RemoveMemberFromTopicReply)
renameFile
Renames the desired file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of RenameFileReply
renameFile
Renames the desired file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (RenameFileReply)
revokeDevice
Removes and wipes a device from the intended Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of RevokeDeviceReply
revokeDevice
Removes and wipes a device from the intended Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (RevokeDeviceReply)
revokeInvite
Removes a pending invitation to a Circle. If the Invite has been accepted, use RevokeDevice() instead.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of RevokeInviteReply
revokeInvite
Removes a pending invitation to a Circle. If the Invite has been accepted, use RevokeDevice() instead.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (RevokeInviteReply)
SecureContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of SecureContentsReply
SecureContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (SecureContentsReply)
SecureFile
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of SecureFileReply
SecureFile
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (SecureFileReply)
serviceStatus
Thrown when fails to make API call
Task of ServiceStatusReply
serviceStatus
Thrown when fails to make API call
Task of ApiResponse (ServiceStatusReply)
SetProfileProperty
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of SetProfilePropertyReply
SetProfileProperty
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (SetProfilePropertyReply)
SetUserId
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of SetUserIdReply
SetUserId
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (SetUserIdReply)
SignDataWithCircleKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of SignDataWithCircleKeyReply
SignDataWithCircleKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (SignDataWithCircleKeyReply)
SignDataWithUserKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of SignDataWithUserKeyReply
SignDataWithUserKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (SignDataWithUserKeyReply)
storeToken
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of StoreTokenReply
storeToken
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of ApiResponse (StoreTokenReply)
unlockUser
Unlock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of UnlockUserReply
unlockUser
Unlock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (UnlockUserReply)
updateTopic
Updates the name and description of an existing topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of UpdateTopicReply
updateTopic
Updates the name and description of an existing topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (UpdateTopicReply)
uploadFile
Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of UploadFileReply
uploadFile
Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (UploadFileReply)
whoAmI
Provides the member ID and the list of the member’s joined devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of WhoAmIReply
whoAmI
Provides the member ID and the list of the member’s joined devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (WhoAmIReply)
Represents a collection of functions to interact with the API endpoints
Initializes a new instance of the class.
Initializes a new instance of the class
Initializes a new instance of the class
using Configuration object
An instance of Configuration
Gets the base path of the API client.
The base path
Sets the base path of the API client.
The base path
Gets or sets the configuration object
An instance of the Configuration
Provides a factory method hook for the creation of exceptions.
Gets the default header.
Dictionary of HTTP header
Add default header.
Header field name.
Header field value.
addMemberToTopic Add a Member to a Topic. Unlike the case with Circles, you add a Member to a Topic directly (no Invite-and-Accept is required).
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
AddMemberToTopicReply
addMemberToTopic Add a Member to a Topic. Unlike the case with Circles, you add a Member to a Topic directly (no Invite-and-Accept is required).
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of AddMemberToTopicReply
addMemberToTopic Add a Member to a Topic. Unlike the case with Circles, you add a Member to a Topic directly (no Invite-and-Accept is required).
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of AddMemberToTopicReply
addMemberToTopic Add a Member to a Topic. Unlike the case with Circles, you add a Member to a Topic directly (no Invite-and-Accept is required).
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (AddMemberToTopicReply)
addMessage Adds a message to the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
AddMessageReply
addMessage Adds a message to the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of AddMessageReply
addMessage Adds a message to the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of AddMessageReply
addMessage Adds a message to the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (AddMessageReply)
addValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
AddValueReply
addValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of AddValueReply
addValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of AddValueReply
addValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (AddValueReply)
ApproveCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApproveCoTInvokeReply
ApproveCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of ApproveCoTInvokeReply
ApproveCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApproveCoTInvokeReply
ApproveCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (ApproveCoTInvokeReply)
authorize Authorizes use of the CircleService
Thrown when fails to make API call
Application `appKey`
AppAuthorizationReply
authorize Authorizes use of the CircleService
Thrown when fails to make API call
Application `appKey`
ApiResponse of AppAuthorizationReply
authorize Authorizes use of the CircleService
Thrown when fails to make API call
Application `appKey`
Task of AppAuthorizationReply
authorize Authorizes use of the CircleService
Thrown when fails to make API call
Application `appKey`
Task of ApiResponse (AppAuthorizationReply)
background Sets the sync status for a Circle to Background, permitting delayed file sync and slower real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
BackgroundReply
background Sets the sync status for a Circle to Background, permitting delayed file sync and slower real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of BackgroundReply
background Sets the sync status for a Circle to Background, permitting delayed file sync and slower real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of BackgroundReply
background Sets the sync status for a Circle to Background, permitting delayed file sync and slower real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (BackgroundReply)
configureService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
ConfigureServiceReply
configureService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
ApiResponse of ConfigureServiceReply
configureService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of ConfigureServiceReply
configureService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of ApiResponse (ConfigureServiceReply)
createCircle Creates a Circle. Initially the current device is the only member of the new Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
CreateCircleReply
createCircle Creates a Circle. Initially the current device is the only member of the new Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of CreateCircleReply
createCircle Creates a Circle. Initially the current device is the only member of the new Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of CreateCircleReply
createCircle Creates a Circle. Initially the current device is the only member of the new Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (CreateCircleReply)
createTopic Create a new Topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
CreateTopicReply
createTopic Create a new Topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of CreateTopicReply
createTopic Create a new Topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of CreateTopicReply
createTopic Create a new Topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (CreateTopicReply)
decrypt Decrypt base64 data using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
DecryptReply
decrypt Decrypt base64 data using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
ApiResponse of DecryptReply
decrypt Decrypt base64 data using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of DecryptReply
decrypt Decrypt base64 data using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of ApiResponse (DecryptReply)
DefineCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DefineCircleOfTrustReply
DefineCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DefineCircleOfTrustReply
DefineCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DefineCircleOfTrustReply
DefineCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DefineCircleOfTrustReply)
DeleteCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DeleteCircleReply
DeleteCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DeleteCircleReply
DeleteCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DeleteCircleReply
DeleteCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DeleteCircleReply)
deleteFile The Circle ID and the FileMap ID for the file you want to delete.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DeleteFileReply
deleteFile The Circle ID and the FileMap ID for the file you want to delete.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DeleteFileReply
deleteFile The Circle ID and the FileMap ID for the file you want to delete.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DeleteFileReply
deleteFile The Circle ID and the FileMap ID for the file you want to delete.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DeleteFileReply)
deleteKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DeleteKeyReply
deleteKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DeleteKeyReply
deleteKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DeleteKeyReply
deleteKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DeleteKeyReply)
DeleteMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DeleteMessageReply
DeleteMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DeleteMessageReply
DeleteMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DeleteMessageReply
DeleteMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DeleteMessageReply)
DenyCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DenyCoTInvokeReply
DenyCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DenyCoTInvokeReply
DenyCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DenyCoTInvokeReply
DenyCoTInvoke
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DenyCoTInvokeReply)
downloadFile Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
DownloadFileReply
downloadFile Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of DownloadFileReply
downloadFile Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of DownloadFileReply
downloadFile Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (DownloadFileReply)
encrypt Encrypts base64 using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
EncryptReply
encrypt Encrypts base64 using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
ApiResponse of EncryptReply
encrypt Encrypts base64 using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of EncryptReply
encrypt Encrypts base64 using a Circle/Topic encryption key.
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of ApiResponse (EncryptReply)
enumCircleMembers Enumerates all the members in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumCircleMembersReply
enumCircleMembers Enumerates all the members in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumCircleMembersReply
enumCircleMembers Enumerates all the members in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumCircleMembersReply
enumCircleMembers Enumerates all the members in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumCircleMembersReply)
enumCircles Enumerates (lists) Circles to which the current device belongs. The Circle engine does discovery in a background thread; as a result, this list is 'best effort,' especially right after startup. Can return a subset of Circles while it’s still in discovery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumCirclesReply
enumCircles Enumerates (lists) Circles to which the current device belongs. The Circle engine does discovery in a background thread; as a result, this list is 'best effort,' especially right after startup. Can return a subset of Circles while it’s still in discovery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumCirclesReply
enumCircles Enumerates (lists) Circles to which the current device belongs. The Circle engine does discovery in a background thread; as a result, this list is 'best effort,' especially right after startup. Can return a subset of Circles while it’s still in discovery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumCirclesReply
enumCircles Enumerates (lists) Circles to which the current device belongs. The Circle engine does discovery in a background thread; as a result, this list is 'best effort,' especially right after startup. Can return a subset of Circles while it’s still in discovery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumCirclesReply)
enumDevices Enumerates all of the devices associated with a Member.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumDevicesReply
enumDevices Enumerates all of the devices associated with a Member.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumDevicesReply
enumDevices Enumerates all of the devices associated with a Member.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumDevicesReply
enumDevices Enumerates all of the devices associated with a Member.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumDevicesReply)
enumFiles Enumerates (lists) all the Files within a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumFilesReply
enumFiles Enumerates (lists) all the Files within a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumFilesReply
enumFiles Enumerates (lists) all the Files within a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumFilesReply
enumFiles Enumerates (lists) all the Files within a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumFilesReply)
enumInvites Enumerates (lists) the invites currently pending for the Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumInvitesReply
enumInvites Enumerates (lists) the invites currently pending for the Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumInvitesReply
enumInvites Enumerates (lists) the invites currently pending for the Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumInvitesReply
enumInvites Enumerates (lists) the invites currently pending for the Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumInvitesReply)
enumKeys
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumKeysReply
enumKeys
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumKeysReply
enumKeys
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumKeysReply
enumKeys
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumKeysReply)
enumRevisions Enumerates (lists) all of the revisions of a file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumRevisionsReply
enumRevisions Enumerates (lists) all of the revisions of a file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumRevisionsReply
enumRevisions Enumerates (lists) all of the revisions of a file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumRevisionsReply
enumRevisions Enumerates (lists) all of the revisions of a file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumRevisionsReply)
enumTopicMembers Enumerates the list of members in the specified topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumTopicMembersReply
enumTopicMembers Enumerates the list of members in the specified topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumTopicMembersReply
enumTopicMembers Enumerates the list of members in the specified topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumTopicMembersReply
enumTopicMembers Enumerates the list of members in the specified topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumTopicMembersReply)
enumTopics Enumerates (lists) the Topics in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
EnumTopicsReply
enumTopics Enumerates (lists) the Topics in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of EnumTopicsReply
enumTopics Enumerates (lists) the Topics in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of EnumTopicsReply
enumTopics Enumerates (lists) the Topics in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (EnumTopicsReply)
foreground Sets the sync status for a Circle to Foreground, enabling faster file sync and minimal delay in real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ForegroundReply
foreground Sets the sync status for a Circle to Foreground, enabling faster file sync and minimal delay in real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of ForegroundReply
foreground Sets the sync status for a Circle to Foreground, enabling faster file sync and minimal delay in real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ForegroundReply
foreground Sets the sync status for a Circle to Foreground, enabling faster file sync and minimal delay in real-time message delivery.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (ForegroundReply)
genInvite Generates the invitation ID and authorization code for a Circle invitation.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GenInviteReply
genInvite Generates the invitation ID and authorization code for a Circle invitation.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GenInviteReply
genInvite Generates the invitation ID and authorization code for a Circle invitation.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GenInviteReply
genInvite Generates the invitation ID and authorization code for a Circle invitation.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GenInviteReply)
GetCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetCircleOfTrustReply
GetCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetCircleOfTrustReply
GetCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetCircleOfTrustReply
GetCircleOfTrust
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetCircleOfTrustReply)
GetCirclePublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetCirclePublicKeyReply
GetCirclePublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetCirclePublicKeyReply
GetCirclePublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetCirclePublicKeyReply
GetCirclePublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetCirclePublicKeyReply)
GetMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetMessageReply
GetMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetMessageReply
GetMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetMessageReply
GetMessage
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetMessageReply)
getMessages Gets the messages from the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetMessagesReply
getMessages Gets the messages from the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetMessagesReply
getMessages Gets the messages from the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetMessagesReply
getMessages Gets the messages from the desired topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetMessagesReply)
GetRAVStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetRAVStatusReply
GetRAVStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetRAVStatusReply
GetRAVStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetRAVStatusReply
GetRAVStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetRAVStatusReply)
GetSecureFileContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetSecureFileContentsReply
GetSecureFileContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetSecureFileContentsReply
GetSecureFileContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetSecureFileContentsReply
GetSecureFileContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetSecureFileContentsReply)
getSyncStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetSyncStatusReply
getSyncStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetSyncStatusReply
getSyncStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetSyncStatusReply
getSyncStatus
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetSyncStatusReply)
GetUserPublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetUserPublicKeyReply
GetUserPublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetUserPublicKeyReply
GetUserPublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetUserPublicKeyReply
GetUserPublicKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetUserPublicKeyReply)
getValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
GetValueReply
getValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of GetValueReply
getValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of GetValueReply
getValue
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (GetValueReply)
joinTopic Joins an existing topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
JoinTopicReply
joinTopic Joins an existing topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of JoinTopicReply
joinTopic Joins an existing topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of JoinTopicReply
joinTopic Joins an existing topic in a Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (JoinTopicReply)
leaveTopic Leave ('unjoin') a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
LeaveTopicReply
leaveTopic Leave ('unjoin') a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of LeaveTopicReply
leaveTopic Leave ('unjoin') a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of LeaveTopicReply
leaveTopic Leave ('unjoin') a Topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (LeaveTopicReply)
lockUser Lock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
LockUserReply
lockUser Lock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of LockUserReply
lockUser Lock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of LockUserReply
lockUser Lock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (LockUserReply)
LoginWithCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
LoginWithCircleReply
LoginWithCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of LoginWithCircleReply
LoginWithCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of LoginWithCircleReply
LoginWithCircle
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (LoginWithCircleReply)
logintoService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
LogintoServiceReply
logintoService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
ApiResponse of LogintoServiceReply
logintoService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of LogintoServiceReply
logintoService
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of ApiResponse (LogintoServiceReply)
PkiDecrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
PkiDecryptReply
PkiDecrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of PkiDecryptReply
PkiDecrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of PkiDecryptReply
PkiDecrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (PkiDecryptReply)
PkiEncrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
PkiEncryptReply
PkiEncrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of PkiEncryptReply
PkiEncrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of PkiEncryptReply
PkiEncrypt
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (PkiEncryptReply)
processInvite Offer an Invite to a device. Generate the Invite first using GenInvite(). An Invite is valid until it is accepted or until it fails five times. An Invite can also time out, which happens after one week.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ProcessInviteReply
processInvite Offer an Invite to a device. Generate the Invite first using GenInvite(). An Invite is valid until it is accepted or until it fails five times. An Invite can also time out, which happens after one week.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of ProcessInviteReply
processInvite Offer an Invite to a device. Generate the Invite first using GenInvite(). An Invite is valid until it is accepted or until it fails five times. An Invite can also time out, which happens after one week.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ProcessInviteReply
processInvite Offer an Invite to a device. Generate the Invite first using GenInvite(). An Invite is valid until it is accepted or until it fails five times. An Invite can also time out, which happens after one week.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (ProcessInviteReply)
removeMember Removes a member from a Circle. Can be used to remove yourself.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
RemoveMemberReply
removeMember Removes a member from a Circle. Can be used to remove yourself.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of RemoveMemberReply
removeMember Removes a member from a Circle. Can be used to remove yourself.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of RemoveMemberReply
removeMember Removes a member from a Circle. Can be used to remove yourself.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (RemoveMemberReply)
removeMemberFromTopic Remove a Member from a Topic. The Member is removed immediately from the current device, but may take a short time to propagate to other devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
RemoveMemberFromTopicReply
removeMemberFromTopic Remove a Member from a Topic. The Member is removed immediately from the current device, but may take a short time to propagate to other devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of RemoveMemberFromTopicReply
removeMemberFromTopic Remove a Member from a Topic. The Member is removed immediately from the current device, but may take a short time to propagate to other devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of RemoveMemberFromTopicReply
removeMemberFromTopic Remove a Member from a Topic. The Member is removed immediately from the current device, but may take a short time to propagate to other devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (RemoveMemberFromTopicReply)
renameFile Renames the desired file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
RenameFileReply
renameFile Renames the desired file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of RenameFileReply
renameFile Renames the desired file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of RenameFileReply
renameFile Renames the desired file.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (RenameFileReply)
revokeDevice Removes and wipes a device from the intended Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
RevokeDeviceReply
revokeDevice Removes and wipes a device from the intended Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of RevokeDeviceReply
revokeDevice Removes and wipes a device from the intended Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of RevokeDeviceReply
revokeDevice Removes and wipes a device from the intended Circle.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (RevokeDeviceReply)
revokeInvite Removes a pending invitation to a Circle. If the Invite has been accepted, use RevokeDevice() instead.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
RevokeInviteReply
revokeInvite Removes a pending invitation to a Circle. If the Invite has been accepted, use RevokeDevice() instead.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of RevokeInviteReply
revokeInvite Removes a pending invitation to a Circle. If the Invite has been accepted, use RevokeDevice() instead.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of RevokeInviteReply
revokeInvite Removes a pending invitation to a Circle. If the Invite has been accepted, use RevokeDevice() instead.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (RevokeInviteReply)
SecureContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
SecureContentsReply
SecureContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of SecureContentsReply
SecureContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of SecureContentsReply
SecureContents
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (SecureContentsReply)
SecureFile
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
SecureFileReply
SecureFile
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of SecureFileReply
SecureFile
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of SecureFileReply
SecureFile
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (SecureFileReply)
serviceStatus
Thrown when fails to make API call
ServiceStatusReply
serviceStatus
Thrown when fails to make API call
ApiResponse of ServiceStatusReply
serviceStatus
Thrown when fails to make API call
Task of ServiceStatusReply
serviceStatus
Thrown when fails to make API call
Task of ApiResponse (ServiceStatusReply)
SetProfileProperty
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
SetProfilePropertyReply
SetProfileProperty
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of SetProfilePropertyReply
SetProfileProperty
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of SetProfilePropertyReply
SetProfileProperty
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (SetProfilePropertyReply)
SetUserId
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
SetUserIdReply
SetUserId
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of SetUserIdReply
SetUserId
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of SetUserIdReply
SetUserId
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (SetUserIdReply)
SignDataWithCircleKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
SignDataWithCircleKeyReply
SignDataWithCircleKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of SignDataWithCircleKeyReply
SignDataWithCircleKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of SignDataWithCircleKeyReply
SignDataWithCircleKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (SignDataWithCircleKeyReply)
SignDataWithUserKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
SignDataWithUserKeyReply
SignDataWithUserKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of SignDataWithUserKeyReply
SignDataWithUserKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of SignDataWithUserKeyReply
SignDataWithUserKey
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (SignDataWithUserKeyReply)
storeToken
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
StoreTokenReply
storeToken
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
ApiResponse of StoreTokenReply
storeToken
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of StoreTokenReply
storeToken
Thrown when fails to make API call
(optional)
Authorization Bearer (optional)
Application `appKey` (optional)
Task of ApiResponse (StoreTokenReply)
unlockUser Unlock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
UnlockUserReply
unlockUser Unlock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of UnlockUserReply
unlockUser Unlock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of UnlockUserReply
unlockUser Unlock the member requesting this action.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (UnlockUserReply)
updateTopic Updates the name and description of an existing topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
UpdateTopicReply
updateTopic Updates the name and description of an existing topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of UpdateTopicReply
updateTopic Updates the name and description of an existing topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of UpdateTopicReply
updateTopic Updates the name and description of an existing topic.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (UpdateTopicReply)
uploadFile Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
UploadFileReply
uploadFile Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of UploadFileReply
uploadFile Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of UploadFileReply
uploadFile Upload a file with content. This method is available in the CircleService and not needed in CoreL2
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (UploadFileReply)
whoAmI Provides the member ID and the list of the member’s joined devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
WhoAmIReply
whoAmI Provides the member ID and the list of the member’s joined devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
ApiResponse of WhoAmIReply
whoAmI Provides the member ID and the list of the member’s joined devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of WhoAmIReply
whoAmI Provides the member ID and the list of the member’s joined devices.
Thrown when fails to make API call
Authorization Bearer
Application `appKey`
Task of ApiResponse (WhoAmIReply)
API client is mainly responsible for making the HTTP call to the API backend.
Allows for extending request processing for generated code.
The RestSharp request object
Allows for extending response processing for generated code.
The RestSharp request object
The RestSharp response object
Initializes a new instance of the class
with default configuration.
Initializes a new instance of the class
with default base path (http://127.0.0.1:31415).
An instance of Configuration.
Initializes a new instance of the class
with default configuration.
The base path.
Gets or sets the default API client for making HTTP calls.
The default API client.
Gets or sets an instance of the IReadableConfiguration.
An instance of the IReadableConfiguration.
helps us to avoid modifying possibly global
configuration values from within a given client. It does not guarantee thread-safety
of the instance in any way.
Gets or sets the RestClient.
An instance of the RestClient
Makes the HTTP request (Sync).
URL path.
HTTP method.
Query parameters.
HTTP body (POST request).
Header parameters.
Form parameters.
File parameters.
Path parameters.
Content Type of the request
Object
Makes the asynchronous HTTP request.
URL path.
HTTP method.
Query parameters.
HTTP body (POST request).
Header parameters.
Form parameters.
File parameters.
Path parameters.
Content type.
The Task instance.
Escape string (url-encoded).
String to be escaped.
Escaped string.
Create FileParameter based on Stream.
Parameter name.
Input stream.
FileParameter.
If parameter is DateTime, output in a formatted string (default ISO 8601), customizable with Configuration.DateTime.
If parameter is a list, join the list with ",".
Otherwise just return the string.
The parameter (header, path, query, form).
Formatted string.
Deserialize the JSON string into a proper object.
The HTTP response.
Object type.
Object representation of the JSON string.
Serialize an input (model) into JSON string
Object.
JSON string.
Check if the given MIME is a JSON MIME.
JSON MIME examples:
application/json
application/json; charset=UTF8
APPLICATION/JSON
application/vnd.company+json
MIME
Returns True if MIME type is json.
Select the Content-Type header's value from the given content-type array:
if JSON type exists in the given array, use it;
otherwise use the first one defined in 'consumes'
The Content-Type array to select from.
The Content-Type header to use.
Select the Accept header's value from the given accepts array:
if JSON exists in the given array, use it;
otherwise use all of them (joining into a string)
The accepts array to select from.
The Accept header to use.
Encode string in base64 format.
String to be encoded.
Encoded string.
Dynamically cast the object into target type.
Object to be casted
Target type
Casted object
Convert stream to byte array
Input stream to be converted
Byte array
URL encode a string
Credit/Ref: https://github.com/restsharp/RestSharp/blob/master/RestSharp/Extensions/StringExtensions.cs#L50
String to be URL encoded
Byte array
Sanitize filename by removing the path
Filename
Filename
Convert params to key/value pairs.
Use collectionFormat to properly format lists and collections.
Key name.
Value object.
A list of KeyValuePairs
Check if generic object is a collection.
True if object is a collection type
Represents a readable-only configuration contract.
Gets the access token.
Access token.
Gets the API key.
API key.
Gets the API key prefix.
API key prefix.
Gets the base path.
Base path.
Gets the date time format.
Date time foramt.
Gets the default header.
Default header.
Gets the temp folder path.
Temp folder path.
Gets the HTTP connection timeout (in milliseconds)
HTTP connection timeout.
Gets the user agent.
User agent.
Gets the username.
Username.
Gets the password.
Password.
Gets the API key with prefix.
API key identifier (authentication scheme).
API key with prefix.
API Response
Gets or sets the status code (HTTP status code)
The status code.
Gets or sets the HTTP headers
HTTP headers
Gets or sets the data (parsed HTTP body)
The data.
Initializes a new instance of the class.
HTTP status code.
HTTP headers.
Data (parsed HTTP body)
Represents a set of configuration settings
Version of the package.
Version of the package.
Identifier for ISO 8601 DateTime Format
See https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx#Anchor_8 for more information.
Default creation of exceptions for a given method name and response object
Gets or sets the default Configuration.
Configuration.
Gets or sets the API key based on the authentication name.
The API key.
Gets or sets the prefix (e.g. Token) of the API key based on the authentication name.
The prefix of the API key.
Initializes a new instance of the class
Initializes a new instance of the class
Initializes a new instance of the class with different settings
Api client
Dictionary of default HTTP header
Username
Password
accessToken
Dictionary of API key
Dictionary of API key prefix
Temp folder path
DateTime format string
HTTP connection timeout (in milliseconds)
HTTP user agent
Initializes a new instance of the Configuration class.
Api client.
Gets an instance of an ApiClient for this configuration
Gets or sets the base path for API access.
Gets or sets the default header.
Gets or sets the HTTP timeout (milliseconds) of ApiClient. Default to 100000 milliseconds.
Gets or sets the HTTP user agent.
Http user agent.
Gets or sets the username (HTTP basic authentication).
The username.
Gets or sets the password (HTTP basic authentication).
The password.
Gets the API key with prefix.
API key identifier (authentication scheme).
API key with prefix.
Gets or sets the access token for OAuth2 authentication.
The access token.
Gets or sets the temporary folder path to store the files downloaded from the server.
Folder path.
Gets or sets the the date time format used when serializing in the ApiClient
By default, it's set to ISO 8601 - "o", for others see:
https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx
and https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx
No validation is done to ensure that the string you're providing is valid
The DateTimeFormat string
Gets or sets the prefix (e.g. Token) of the API key based on the authentication name.
The prefix of the API key.
Gets or sets the API key based on the authentication name.
The API key.
Add default header.
Header field name.
Header field value.
Creates a new based on this instance.
Returns a string with essential information for debugging.
Add Api Key Header.
Api Key name.
Api Key value.
Sets the API key prefix.
Api Key name.
Api Key value.
Formatter for 'date' swagger formats ss defined by full-date - RFC3339
see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types
Initializes a new instance of the class.
API Exception
Gets or sets the error code (HTTP status code)
The error code (HTTP status code).
Gets or sets the error content (body json object)
The error content (Http response body).
Initializes a new instance of the class.
Initializes a new instance of the class.
HTTP status code.
Error message.
Initializes a new instance of the class.
HTTP status code.
Error message.
Error content.
Represents configuration aspects required to interact with the API endpoints.
Gets or sets the configuration object
An instance of the Configuration
Gets the base path of the API client.
The base path
Provides a factory method hook for the creation of exceptions.
provides a compile-time extension point for globally configuring
API Clients.
A customized implementation via partial class may reside in another file and may
be excluded from automatic generation via a .swagger-codegen-ignore file.
A delegate to ExceptionFactory method
Method name
Response
Exceptions