136 KiB

Raw Permalink Blame History

<<<<<<< Updated upstream

CircleSDK.Api.CircleApi

All URIs are relative to http://127.0.0.1:31415

Method	HTTP request	Description
AddMemberToTopic	POST /v1/addMemberToTopic	addMemberToTopic
AddMessage	POST /v1/addMessage	addMessage
AddValue	POST /v1/addValue	addValue
ApproveCoTInvoke	POST /v1/approveCoTInvoke	ApproveCoTInvoke
Authorize	POST /v1/authorize	authorize
Background	POST /v1/background	background
ConfigureService	POST /v1/configureService	configureService
CreateCircle	POST /v1/createCircle	createCircle
CreateTopic	POST /v1/createTopic	createTopic
Decrypt	POST /v1/decrypt	decrypt
DefineCircleOfTrust	POST /v1/defineCircleOfTrust	DefineCircleOfTrust
DeleteCircle	POST /v1/deleteCircle	DeleteCircle
DeleteFile	POST /v1/deleteFile	deleteFile
DeleteKey	POST /v1/deleteKey	deleteKey
DeleteMessage	POST /v1/deleteMessage	DeleteMessage
DenyCoTInvoke	POST /v1/denyCoTInvoke	DenyCoTInvoke
DownloadFile	POST /v1/downloadFile	downloadFile
Encrypt	POST /v1/encrypt	encrypt
EnumCircleMembers	POST /v1/enumCircleMembers	enumCircleMembers
EnumCircles	POST /v1/enumCircles	enumCircles
EnumDevices	POST /v1/enumDevices	enumDevices
EnumFiles	POST /v1/enumFiles	enumFiles
EnumInvites	POST /v1/enumInvites	enumInvites
EnumKeys	POST /v1/enumKeys	enumKeys
EnumRevisions	POST /v1/enumRevisions	enumRevisions
EnumTopicMembers	POST /v1/enumTopicMembers	enumTopicMembers
EnumTopics	POST /v1/enumTopics	enumTopics
Foreground	POST /v1/foreground	foreground
GenInvite	POST /v1/genInvite	genInvite
GetCircleOfTrust	POST /v1/getCircleOfTrust	GetCircleOfTrust
GetCirclePublicKey	POST /v1/getCirclePublicKey	GetCirclePublicKey
GetMessage	POST /v1/getMessage	GetMessage
GetMessages	POST /v1/getMessages	getMessages
GetRAVStatus	POST /v1/getRAVStatus	GetRAVStatus
GetSecureFileContents	POST /v1/getSecureFileContents	GetSecureFileContents
GetSyncStatus	POST /v1/getSyncStatus	getSyncStatus
GetUserPublicKey	POST /v1/getUserPublicKey	GetUserPublicKey
GetValue	POST /v1/getValue	getValue
JoinTopic	POST /v1/joinTopic	joinTopic
LeaveTopic	POST /v1/leaveTopic	leaveTopic
LockUser	POST /v1/lockUser	lockUser
LoginWithCircle	POST /v1/loginWithCircle	LoginWithCircle
LogintoService	POST /v1/logintoService	logintoService
ProcessInvite	POST /v1/processInvite	processInvite
RemoveMember	POST /v1/removeMember	removeMember

=======

IO.Swagger.Api.CircleApi

All URIs are relative to http://localhost:31415

Method	HTTP request	Description
AddFile	POST /v1/addFile	addFile
AddMemberToTopic	POST /v1/addMemberToTopic	addMemberToTopic
AddMessge	POST /v1/addMessge	addMessge
Authorize	POST /v1/authorize	authorize
Background	POST /v1/background	background
CreateCircle	POST /v1/createCircle	createCircle
CreateTopic	POST /v1/createTopic	createTopic
DecryptFile	POST /v1/decryptFile	decryptFile
DeleteFile	POST /v1/deleteFile	deleteFile
EncryptFile	POST /v1/encryptFile	encryptFile
EnumCircleMembers	GET /v1/enumCircleMembers	enumCircleMembers
EnumCircles	GET /v1/enumCircles	enumCircles
EnumDevices	GET /v1/enumDevices	enumDevices
EnumFiles	GET /v1/enumFiles	enumFiles
EnumInvites	GET /v1/enumInvites	enumInvites
EnumRevisions	GET /v1/enumRevisions	enumRevisions
EnumTopicMembers	GET /v1/enumTopicMembers	enumTopicMembers
EnumTopics	GET /v1/enumTopics	enumTopics
Foreground	POST /v1/foreground	foreground
GenInvite	POST /v1/genInvite	genInvite
GetFile	GET /v1/getFile	getFile
GetMessges	GET /v1/getMessges	getMessges
GetTopicKey	GET /v1/getTopicKey	getTopicKey
Invite	POST /v1/invite	invite
JoinTopic	POST /v1/joinTopic	joinTopic
LeaveTopic	POST /v1/leaveTopic	leaveTopic

Stashed changes RemoveMemberFromTopic | POST /v1/removeMemberFromTopic | removeMemberFromTopic RenameFile | POST /v1/renameFile | renameFile RevokeDevice | POST /v1/revokeDevice | revokeDevice RevokeInvite | POST /v1/revokeInvite | revokeInvite <<<<<<< Updated upstream SecureContents | POST /v1/secureContents | SecureContents SecureFile | POST /v1/secureFile | SecureFile ServiceStatus | POST /v1/serviceStatus | serviceStatus SetUserId | POST /v1/setUserId | SetUserId SignDataWithCircleKey | POST /v1/signDataWithCircleKey | SignDataWithCircleKey SignDataWithUserKey | POST /v1/signDataWithUserKey | SignDataWithUserKey StoreToken | POST /v1/storeToken | storeToken UnlockUser | POST /v1/unlockUser | unlockUser UpdateTopic | POST /v1/updateTopic | updateTopic UploadFile | POST /v1/uploadFile | uploadFile WhoAmI | POST /v1/whoAmI | whoAmI

AddMemberToTopic

AddMemberToTopicReply AddMemberToTopic (AddMemberToTopicRequest body, string authorization, string xCircleAppkey)

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).

WhoAmI | GET /v1/whoAmI | whoAmI

AddFile

AddFileReply AddFile (AddFileRequest body, string xCircleAppkey)

addFile

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class AddFileExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new AddFileRequest(); // AddFileRequest | 
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // addFile
                AddFileReply result = apiInstance.AddFile(body, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.AddFile: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	AddFileRequest
xCircleAppkey	string	Application `appKey`

Return type

AddFileReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddMemberToTopic

AddMemberToTopicReply AddMemberToTopic (AddMemberToTopicRequest body, string xCircleAppkey)

addMemberToTopic

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class AddMemberToTopicExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new AddMemberToTopicRequest(); // AddMemberToTopicRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // addMemberToTopic
<<<<<<< Updated upstream
                AddMemberToTopicReply result = apiInstance.AddMemberToTopic(body, authorization, xCircleAppkey);
=======
                AddMemberToTopicReply result = apiInstance.AddMemberToTopic(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.AddMemberToTopic: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	AddMemberToTopicRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

AddMemberToTopicReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README] <<<<<<< Updated upstream

AddMessage

AddMessageReply AddMessage (AddMessageRequest body, string authorization, string xCircleAppkey)

addMessage

Adds a message to the desired topic.

AddMessge

AddMessgeReply AddMessge (AddMessgeRequest body, string xCircleAppkey)

addMessge

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class AddMessageExample
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class AddMessgeExample
>>>>>>> Stashed changes
    {
        public void main()
        {
            var apiInstance = new CircleApi();
<<<<<<< Updated upstream
            var body = new AddMessageRequest(); // AddMessageRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
=======
            var body = new AddMessgeRequest(); // AddMessgeRequest | 
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
<<<<<<< Updated upstream
                // addMessage
                AddMessageReply result = apiInstance.AddMessage(body, authorization, xCircleAppkey);
=======
                // addMessge
                AddMessgeReply result = apiInstance.AddMessge(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
<<<<<<< Updated upstream
                Debug.Print("Exception when calling CircleApi.AddMessage: " + e.Message );
=======
                Debug.Print("Exception when calling CircleApi.AddMessge: " + e.Message );
>>>>>>> Stashed changes
            }
        }
    }
}

Parameters

Name	Type	Description
<<<<<<< Updated upstream
body	AddMessageRequest
authorization	string	Authorization Bearer

======= body | AddMessgeRequest| |

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

<<<<<<< Updated upstream AddMessageReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddValue

AddValueReply AddValue (AddValueRequest body, string authorization, string xCircleAppkey)

addValue

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class AddValueExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new AddValueRequest(); // AddValueRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // addValue
                AddValueReply result = apiInstance.AddValue(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.AddValue: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	AddValueRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

AddValueReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApproveCoTInvoke

ApproveCoTInvokeReply ApproveCoTInvoke (ApproveCoTInvokeRequest body, string authorization, string xCircleAppkey)

ApproveCoTInvoke

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class ApproveCoTInvokeExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new ApproveCoTInvokeRequest(); // ApproveCoTInvokeRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // ApproveCoTInvoke
                ApproveCoTInvokeReply result = apiInstance.ApproveCoTInvoke(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.ApproveCoTInvoke: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	ApproveCoTInvokeRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

ApproveCoTInvokeReply

AddMessgeReply

Stashed changes

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorize

<<<<<<< Updated upstream

AppAuthorizationReply Authorize (AppAuthorizationRequest body, string xCircleAppkey)

authorize

Authorizes use of the CircleService

=======

GenerateTokenReply Authorize (AppAuthorization body, string xCircleAppkey)

authorize

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class AuthorizeExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
<<<<<<< Updated upstream
            var body = new AppAuthorizationRequest(); // AppAuthorizationRequest | 
=======
            var body = new AppAuthorization(); // AppAuthorization | 
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // authorize
<<<<<<< Updated upstream
                AppAuthorizationReply result = apiInstance.Authorize(body, xCircleAppkey);
=======
                GenerateTokenReply result = apiInstance.Authorize(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.Authorize: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
<<<<<<< Updated upstream
body	AppAuthorizationRequest

======= body | AppAuthorization| |

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

<<<<<<< Updated upstream AppAuthorizationReply

GenerateTokenReply

Stashed changes

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Background

<<<<<<< Updated upstream

BackgroundReply Background (BackgroundRequest body, string authorization, string xCircleAppkey)

background

Sets the sync status for a Circle to Background, permitting delayed file sync and slower real-time message delivery.

=======

BackgroundReply Background (BackgroundRequest body, string xCircleAppkey)

background

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class BackgroundExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new BackgroundRequest(); // BackgroundRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // background
<<<<<<< Updated upstream
                BackgroundReply result = apiInstance.Background(body, authorization, xCircleAppkey);
=======
                BackgroundReply result = apiInstance.Background(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.Background: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	BackgroundRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

BackgroundReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README] <<<<<<< Updated upstream

ConfigureService

ConfigureServiceReply ConfigureService (ConfigureServiceRequest body = null, string authorization = null, string xCircleAppkey = null)

configureService

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class ConfigureServiceExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new ConfigureServiceRequest(); // ConfigureServiceRequest |  (optional) 
            var authorization = authorization_example;  // string | Authorization Bearer (optional) 
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey` (optional) 

            try
            {
                // configureService
                ConfigureServiceReply result = apiInstance.ConfigureService(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.ConfigureService: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	ConfigureServiceRequest		[optional]
authorization	string	Authorization Bearer	[optional]
xCircleAppkey	string	Application `appKey`	[optional]

Return type

ConfigureServiceReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateCircle

CreateCircleReply CreateCircle (CreateCircleRequest body, string authorization, string xCircleAppkey)

createCircle

Creates a Circle. Initially the current device is the only member of the new Circle.

=======

CreateCircle

CreateCircleReply CreateCircle (CreateCircleRequest body, string xCircleAppkey)

createCircle

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class CreateCircleExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new CreateCircleRequest(); // CreateCircleRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // createCircle
<<<<<<< Updated upstream
                CreateCircleReply result = apiInstance.CreateCircle(body, authorization, xCircleAppkey);
=======
                CreateCircleReply result = apiInstance.CreateCircle(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.CreateCircle: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	CreateCircleRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

CreateCircleReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateTopic

<<<<<<< Updated upstream

CreateTopicReply CreateTopic (CreateTopicRequest body, string authorization, string xCircleAppkey)

createTopic

Create a new Topic in a Circle.

=======

CreateTopicReply CreateTopic (CreateTopicRequest body, string xCircleAppkey)

createTopic

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class CreateTopicExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new CreateTopicRequest(); // CreateTopicRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // createTopic
<<<<<<< Updated upstream
                CreateTopicReply result = apiInstance.CreateTopic(body, authorization, xCircleAppkey);
=======
                CreateTopicReply result = apiInstance.CreateTopic(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.CreateTopic: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	CreateTopicRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

CreateTopicReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README] <<<<<<< Updated upstream

Decrypt

DecryptReply Decrypt (DecryptRequest body = null, string authorization = null, string xCircleAppkey = null)

decrypt

Decrypt base64 data using a Circle/Topic encryption key.

DecryptFile

DecryptFileReply DecryptFile (DecryptFileRequest body, string xCircleAppkey)

decryptFile

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class DecryptExample
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class DecryptFileExample
>>>>>>> Stashed changes
    {
        public void main()
        {
            var apiInstance = new CircleApi();
<<<<<<< Updated upstream
            var body = new DecryptRequest(); // DecryptRequest |  (optional) 
            var authorization = authorization_example;  // string | Authorization Bearer (optional) 
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey` (optional) 

            try
            {
                // decrypt
                DecryptReply result = apiInstance.Decrypt(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.Decrypt: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	DecryptRequest		[optional]
authorization	string	Authorization Bearer	[optional]
xCircleAppkey	string	Application `appKey`	[optional]

Return type

DecryptReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DefineCircleOfTrust

DefineCircleOfTrustReply DefineCircleOfTrust (DefineCircleOfTrustRequest body, string authorization, string xCircleAppkey)

DefineCircleOfTrust

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class DefineCircleOfTrustExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new DefineCircleOfTrustRequest(); // DefineCircleOfTrustRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
=======
            var body = new DecryptFileRequest(); // DecryptFileRequest | 
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
<<<<<<< Updated upstream
                // DefineCircleOfTrust
                DefineCircleOfTrustReply result = apiInstance.DefineCircleOfTrust(body, authorization, xCircleAppkey);
=======
                // decryptFile
                DecryptFileReply result = apiInstance.DecryptFile(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
<<<<<<< Updated upstream
                Debug.Print("Exception when calling CircleApi.DefineCircleOfTrust: " + e.Message );
=======
                Debug.Print("Exception when calling CircleApi.DecryptFile: " + e.Message );
>>>>>>> Stashed changes
            }
        }
    }
}

Parameters

Name	Type	Description
<<<<<<< Updated upstream
body	DefineCircleOfTrustRequest
authorization	string	Authorization Bearer

======= body | DecryptFileRequest| |

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

<<<<<<< Updated upstream DefineCircleOfTrustReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCircle

DeleteCircleReply DeleteCircle (DeleteCircleRequest body, string authorization, string xCircleAppkey)

DeleteCircle

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class DeleteCircleExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new DeleteCircleRequest(); // DeleteCircleRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // DeleteCircle
                DeleteCircleReply result = apiInstance.DeleteCircle(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.DeleteCircle: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	DeleteCircleRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

DeleteCircleReply

DecryptFileReply

Stashed changes

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteFile

<<<<<<< Updated upstream

DeleteFileReply DeleteFile (DeleteFileRequest body, string authorization, string xCircleAppkey)

deleteFile

The Circle ID and the FileMap ID for the file you want to delete.

=======

DeleteFileReply DeleteFile (DeleteFileRequest body, string xCircleAppkey)

deleteFile

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class DeleteFileExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new DeleteFileRequest(); // DeleteFileRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // deleteFile
<<<<<<< Updated upstream
                DeleteFileReply result = apiInstance.DeleteFile(body, authorization, xCircleAppkey);
=======
                DeleteFileReply result = apiInstance.DeleteFile(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.DeleteFile: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	DeleteFileRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

DeleteFileReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README] <<<<<<< Updated upstream

DeleteKey

DeleteKeyReply DeleteKey (DeleteKeyRequest body, string authorization, string xCircleAppkey)

deleteKey

EncryptFile

EncryptFileReply EncryptFile (EncryptFileRequest body, string xCircleAppkey)

encryptFile

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class DeleteKeyExample
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class EncryptFileExample
>>>>>>> Stashed changes
    {
        public void main()
        {
            var apiInstance = new CircleApi();
<<<<<<< Updated upstream
            var body = new DeleteKeyRequest(); // DeleteKeyRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
=======
            var body = new EncryptFileRequest(); // EncryptFileRequest | 
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
<<<<<<< Updated upstream
                // deleteKey
                DeleteKeyReply result = apiInstance.DeleteKey(body, authorization, xCircleAppkey);
=======
                // encryptFile
                EncryptFileReply result = apiInstance.EncryptFile(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
<<<<<<< Updated upstream
                Debug.Print("Exception when calling CircleApi.DeleteKey: " + e.Message );
=======
                Debug.Print("Exception when calling CircleApi.EncryptFile: " + e.Message );
>>>>>>> Stashed changes
            }
        }
    }
}

Parameters

Name	Type	Description
<<<<<<< Updated upstream
body	DeleteKeyRequest
authorization	string	Authorization Bearer

======= body | EncryptFileRequest| |

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

<<<<<<< Updated upstream DeleteKeyReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMessage

DeleteMessageReply DeleteMessage (DeleteMessageRequest body, string authorization, string xCircleAppkey)

DeleteMessage

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class DeleteMessageExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new DeleteMessageRequest(); // DeleteMessageRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // DeleteMessage
                DeleteMessageReply result = apiInstance.DeleteMessage(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.DeleteMessage: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	DeleteMessageRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

DeleteMessageReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DenyCoTInvoke

DenyCoTInvokeReply DenyCoTInvoke (DenyCoTInvokeRequest body, string authorization, string xCircleAppkey)

DenyCoTInvoke

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class DenyCoTInvokeExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new DenyCoTInvokeRequest(); // DenyCoTInvokeRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // DenyCoTInvoke
                DenyCoTInvokeReply result = apiInstance.DenyCoTInvoke(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.DenyCoTInvoke: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	DenyCoTInvokeRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

DenyCoTInvokeReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadFile

DownloadFileReply DownloadFile (DownloadFileRequest body, string authorization, string xCircleAppkey)

downloadFile

Upload a file with content. This method is available in the CircleService and not needed in CoreL2

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class DownloadFileExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new DownloadFileRequest(); // DownloadFileRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // downloadFile
                DownloadFileReply result = apiInstance.DownloadFile(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.DownloadFile: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	DownloadFileRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

DownloadFileReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Encrypt

EncryptReply Encrypt (EncryptRequest body = null, string authorization = null, string xCircleAppkey = null)

encrypt

Encrypts base64 using a Circle/Topic encryption key.

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class EncryptExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new EncryptRequest(); // EncryptRequest |  (optional) 
            var authorization = authorization_example;  // string | Authorization Bearer (optional) 
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey` (optional) 

            try
            {
                // encrypt
                EncryptReply result = apiInstance.Encrypt(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.Encrypt: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	EncryptRequest		[optional]
authorization	string	Authorization Bearer	[optional]
xCircleAppkey	string	Application `appKey`	[optional]

Return type

EncryptReply

EncryptFileReply

Stashed changes

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnumCircleMembers

<<<<<<< Updated upstream

EnumCircleMembersReply EnumCircleMembers (EnumCircleMembersRequest body, string authorization, string xCircleAppkey)

enumCircleMembers

Enumerates all the members in a Circle.

=======

EnumCircleMembersReply EnumCircleMembers (EnumCircleMembersRequest body, string xCircleAppkey)

enumCircleMembers

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class EnumCircleMembersExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new EnumCircleMembersRequest(); // EnumCircleMembersRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // enumCircleMembers
<<<<<<< Updated upstream
                EnumCircleMembersReply result = apiInstance.EnumCircleMembers(body, authorization, xCircleAppkey);
=======
                EnumCircleMembersReply result = apiInstance.EnumCircleMembers(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.EnumCircleMembers: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	EnumCircleMembersRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

EnumCircleMembersReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnumCircles

<<<<<<< Updated upstream

EnumCirclesReply EnumCircles (EnumCirclesRequest body, string authorization, string xCircleAppkey)

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.

=======

EnumCirclesReply EnumCircles (EnumCirclesRequest body, string xCircleAppkey)

enumCircles

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class EnumCirclesExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new EnumCirclesRequest(); // EnumCirclesRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // enumCircles
<<<<<<< Updated upstream
                EnumCirclesReply result = apiInstance.EnumCircles(body, authorization, xCircleAppkey);
=======
                EnumCirclesReply result = apiInstance.EnumCircles(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.EnumCircles: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	EnumCirclesRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

EnumCirclesReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnumDevices

<<<<<<< Updated upstream

EnumDevicesReply EnumDevices (EnumDevicesRequest body, string authorization, string xCircleAppkey)

enumDevices

Enumerates all of the devices associated with a Member.

=======

EnumDevicesReply EnumDevices (EnumDevicesRequest body, string xCircleAppkey)

enumDevices

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class EnumDevicesExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new EnumDevicesRequest(); // EnumDevicesRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // enumDevices
<<<<<<< Updated upstream
                EnumDevicesReply result = apiInstance.EnumDevices(body, authorization, xCircleAppkey);
=======
                EnumDevicesReply result = apiInstance.EnumDevices(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.EnumDevices: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	EnumDevicesRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

EnumDevicesReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnumFiles

<<<<<<< Updated upstream

EnumFilesReply EnumFiles (EnumFilesRequest body, string authorization, string xCircleAppkey)

enumFiles

Enumerates (lists) all the Files within a Topic.

=======

EnumFilesReply EnumFiles (EnumFilesRequest body, string xCircleAppkey)

enumFiles

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class EnumFilesExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new EnumFilesRequest(); // EnumFilesRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // enumFiles
<<<<<<< Updated upstream
                EnumFilesReply result = apiInstance.EnumFiles(body, authorization, xCircleAppkey);
=======
                EnumFilesReply result = apiInstance.EnumFiles(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.EnumFiles: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	EnumFilesRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

EnumFilesReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnumInvites

<<<<<<< Updated upstream

EnumInvitesReply EnumInvites (EnumInvitesRequest body, string authorization, string xCircleAppkey)

enumInvites

Enumerates (lists) the invites currently pending for the Circle.

=======

EnumInvitesReply EnumInvites (EnumInvitesRequest body, string xCircleAppkey)

enumInvites

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class EnumInvitesExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new EnumInvitesRequest(); // EnumInvitesRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // enumInvites
<<<<<<< Updated upstream
                EnumInvitesReply result = apiInstance.EnumInvites(body, authorization, xCircleAppkey);
=======
                EnumInvitesReply result = apiInstance.EnumInvites(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.EnumInvites: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	EnumInvitesRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

EnumInvitesReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README] <<<<<<< Updated upstream

EnumKeys

EnumKeysReply EnumKeys (EnumKeysRequest body, string authorization, string xCircleAppkey)

enumKeys

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class EnumKeysExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new EnumKeysRequest(); // EnumKeysRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // enumKeys
                EnumKeysReply result = apiInstance.EnumKeys(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.EnumKeys: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	EnumKeysRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

EnumKeysReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnumRevisions

EnumRevisionsReply EnumRevisions (EnumRevisionsRequest body, string authorization, string xCircleAppkey)

enumRevisions

Enumerates (lists) all of the revisions of a file.

=======

EnumRevisions

EnumRevisionsReply EnumRevisions (EnumRevisionsRequest body, string xCircleAppkey)

enumRevisions

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class EnumRevisionsExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new EnumRevisionsRequest(); // EnumRevisionsRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // enumRevisions
<<<<<<< Updated upstream
                EnumRevisionsReply result = apiInstance.EnumRevisions(body, authorization, xCircleAppkey);
=======
                EnumRevisionsReply result = apiInstance.EnumRevisions(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.EnumRevisions: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	EnumRevisionsRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

EnumRevisionsReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnumTopicMembers

<<<<<<< Updated upstream

EnumTopicMembersReply EnumTopicMembers (EnumTopicMembersRequest body, string authorization, string xCircleAppkey)

enumTopicMembers

Enumerates the list of members in the specified topic.

=======

EnumTopicMembersReply EnumTopicMembers (EnumTopicMembersRequest body, string xCircleAppkey)

enumTopicMembers

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class EnumTopicMembersExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new EnumTopicMembersRequest(); // EnumTopicMembersRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // enumTopicMembers
<<<<<<< Updated upstream
                EnumTopicMembersReply result = apiInstance.EnumTopicMembers(body, authorization, xCircleAppkey);
=======
                EnumTopicMembersReply result = apiInstance.EnumTopicMembers(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.EnumTopicMembers: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	EnumTopicMembersRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

EnumTopicMembersReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnumTopics

<<<<<<< Updated upstream

EnumTopicsReply EnumTopics (EnumTopicsRequest body, string authorization, string xCircleAppkey)

enumTopics

Enumerates (lists) the Topics in a Circle.

=======

EnumTopicsReply EnumTopics (EnumTopicsRequest body, string xCircleAppkey)

enumTopics

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class EnumTopicsExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new EnumTopicsRequest(); // EnumTopicsRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // enumTopics
<<<<<<< Updated upstream
                EnumTopicsReply result = apiInstance.EnumTopics(body, authorization, xCircleAppkey);
=======
                EnumTopicsReply result = apiInstance.EnumTopics(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.EnumTopics: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	EnumTopicsRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

EnumTopicsReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Foreground

<<<<<<< Updated upstream

ForegroundReply Foreground (ForegroundRequest body, string authorization, string xCircleAppkey)

foreground

Sets the sync status for a Circle to Foreground, enabling faster file sync and minimal delay in real-time message delivery.

=======

ForegroundReply Foreground (ForegroundRequest body, string xCircleAppkey)

foreground

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class ForegroundExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new ForegroundRequest(); // ForegroundRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // foreground
<<<<<<< Updated upstream
                ForegroundReply result = apiInstance.Foreground(body, authorization, xCircleAppkey);
=======
                ForegroundReply result = apiInstance.Foreground(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.Foreground: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	ForegroundRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

ForegroundReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GenInvite

<<<<<<< Updated upstream

GenInviteReply GenInvite (GenInviteRequest body, string authorization, string xCircleAppkey)

genInvite

Generates the invitation ID and authorization code for a Circle invitation.

=======

GenInviteReply GenInvite (GenInviteRequest body, string xCircleAppkey)

genInvite

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class GenInviteExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new GenInviteRequest(); // GenInviteRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // genInvite
<<<<<<< Updated upstream
                GenInviteReply result = apiInstance.GenInvite(body, authorization, xCircleAppkey);
=======
                GenInviteReply result = apiInstance.GenInvite(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.GenInvite: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	GenInviteRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

GenInviteReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README] <<<<<<< Updated upstream

GetCircleOfTrust

GetCircleOfTrustReply GetCircleOfTrust (GetCircleOfTrustRequest body, string authorization, string xCircleAppkey)

GetCircleOfTrust

GetFile

GetFileReply GetFile (GetFileRequest body, string xCircleAppkey)

getFile

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class GetCircleOfTrustExample
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class GetFileExample
>>>>>>> Stashed changes
    {
        public void main()
        {
            var apiInstance = new CircleApi();
<<<<<<< Updated upstream
            var body = new GetCircleOfTrustRequest(); // GetCircleOfTrustRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
=======
            var body = new GetFileRequest(); // GetFileRequest | 
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
<<<<<<< Updated upstream
                // GetCircleOfTrust
                GetCircleOfTrustReply result = apiInstance.GetCircleOfTrust(body, authorization, xCircleAppkey);
=======
                // getFile
                GetFileReply result = apiInstance.GetFile(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
<<<<<<< Updated upstream
                Debug.Print("Exception when calling CircleApi.GetCircleOfTrust: " + e.Message );
=======
                Debug.Print("Exception when calling CircleApi.GetFile: " + e.Message );
>>>>>>> Stashed changes
            }
        }
    }
}

Parameters

Name	Type	Description
<<<<<<< Updated upstream
body	GetCircleOfTrustRequest
authorization	string	Authorization Bearer

======= body | GetFileRequest| |

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

<<<<<<< Updated upstream GetCircleOfTrustReply

GetFileReply

Stashed changes

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README] <<<<<<< Updated upstream

GetCirclePublicKey

GetCirclePublicKeyReply GetCirclePublicKey (GetCirclePublicKeyRequest body, string authorization, string xCircleAppkey)

GetCirclePublicKey

GetMessges

GetMessgesReply GetMessges (GetMessgesRequest body, string xCircleAppkey)

getMessges

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class GetCirclePublicKeyExample
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class GetMessgesExample
>>>>>>> Stashed changes
    {
        public void main()
        {
            var apiInstance = new CircleApi();
<<<<<<< Updated upstream
            var body = new GetCirclePublicKeyRequest(); // GetCirclePublicKeyRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
=======
            var body = new GetMessgesRequest(); // GetMessgesRequest | 
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
<<<<<<< Updated upstream
                // GetCirclePublicKey
                GetCirclePublicKeyReply result = apiInstance.GetCirclePublicKey(body, authorization, xCircleAppkey);
=======
                // getMessges
                GetMessgesReply result = apiInstance.GetMessges(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
<<<<<<< Updated upstream
                Debug.Print("Exception when calling CircleApi.GetCirclePublicKey: " + e.Message );
=======
                Debug.Print("Exception when calling CircleApi.GetMessges: " + e.Message );
>>>>>>> Stashed changes
            }
        }
    }
}

Parameters

Name	Type	Description
<<<<<<< Updated upstream
body	GetCirclePublicKeyRequest
authorization	string	Authorization Bearer

======= body | GetMessgesRequest| |

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

<<<<<<< Updated upstream GetCirclePublicKeyReply

GetMessgesReply

Stashed changes

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README] <<<<<<< Updated upstream

GetMessage

GetMessageReply GetMessage (GetMessageRequest body, string authorization, string xCircleAppkey)

GetMessage

GetTopicKey

GetTopicKeyReply GetTopicKey (GetTopicKeyRequest body, string xCircleAppkey)

getTopicKey

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class GetMessageExample
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class GetTopicKeyExample
>>>>>>> Stashed changes
    {
        public void main()
        {
            var apiInstance = new CircleApi();
<<<<<<< Updated upstream
            var body = new GetMessageRequest(); // GetMessageRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
=======
            var body = new GetTopicKeyRequest(); // GetTopicKeyRequest | 
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
<<<<<<< Updated upstream
                // GetMessage
                GetMessageReply result = apiInstance.GetMessage(body, authorization, xCircleAppkey);
=======
                // getTopicKey
                GetTopicKeyReply result = apiInstance.GetTopicKey(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
<<<<<<< Updated upstream
                Debug.Print("Exception when calling CircleApi.GetMessage: " + e.Message );
=======
                Debug.Print("Exception when calling CircleApi.GetTopicKey: " + e.Message );
>>>>>>> Stashed changes
            }
        }
    }
}

Parameters

Name	Type	Description
<<<<<<< Updated upstream
body	GetMessageRequest
authorization	string	Authorization Bearer

======= body | GetTopicKeyRequest| |

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

<<<<<<< Updated upstream GetMessageReply

GetTopicKeyReply

Stashed changes

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README] <<<<<<< Updated upstream

GetMessages

GetMessagesReply GetMessages (GetMessagesRequest body, string authorization, string xCircleAppkey)

getMessages

Gets the messages from the desired topic.

Invite

InviteReply Invite (InviteRequest body, string xCircleAppkey)

invite

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class GetMessagesExample
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class InviteExample
>>>>>>> Stashed changes
    {
        public void main()
        {
            var apiInstance = new CircleApi();
<<<<<<< Updated upstream
            var body = new GetMessagesRequest(); // GetMessagesRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
=======
            var body = new InviteRequest(); // InviteRequest | 
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
<<<<<<< Updated upstream
                // getMessages
                GetMessagesReply result = apiInstance.GetMessages(body, authorization, xCircleAppkey);
=======
                // invite
                InviteReply result = apiInstance.Invite(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
<<<<<<< Updated upstream
                Debug.Print("Exception when calling CircleApi.GetMessages: " + e.Message );
=======
                Debug.Print("Exception when calling CircleApi.Invite: " + e.Message );
>>>>>>> Stashed changes
            }
        }
    }
}

Parameters

Name	Type	Description
<<<<<<< Updated upstream
body	GetMessagesRequest
authorization	string	Authorization Bearer

======= body | InviteRequest| |

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

<<<<<<< Updated upstream GetMessagesReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRAVStatus

GetRAVStatusReply GetRAVStatus (GetRAVStatusRequest body, string authorization, string xCircleAppkey)

GetRAVStatus

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class GetRAVStatusExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new GetRAVStatusRequest(); // GetRAVStatusRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // GetRAVStatus
                GetRAVStatusReply result = apiInstance.GetRAVStatus(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.GetRAVStatus: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	GetRAVStatusRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

GetRAVStatusReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSecureFileContents

GetSecureFileContentsReply GetSecureFileContents (GetSecureFileContentsRequest body, string authorization, string xCircleAppkey)

GetSecureFileContents

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class GetSecureFileContentsExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new GetSecureFileContentsRequest(); // GetSecureFileContentsRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // GetSecureFileContents
                GetSecureFileContentsReply result = apiInstance.GetSecureFileContents(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.GetSecureFileContents: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	GetSecureFileContentsRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

GetSecureFileContentsReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSyncStatus

GetSyncStatusReply GetSyncStatus (GetSyncStatusRequest body, string authorization, string xCircleAppkey)

getSyncStatus

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class GetSyncStatusExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new GetSyncStatusRequest(); // GetSyncStatusRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // getSyncStatus
                GetSyncStatusReply result = apiInstance.GetSyncStatus(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.GetSyncStatus: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	GetSyncStatusRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

GetSyncStatusReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUserPublicKey

GetUserPublicKeyReply GetUserPublicKey (GetUserPublicKeyRequest body, string authorization, string xCircleAppkey)

GetUserPublicKey

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class GetUserPublicKeyExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new GetUserPublicKeyRequest(); // GetUserPublicKeyRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // GetUserPublicKey
                GetUserPublicKeyReply result = apiInstance.GetUserPublicKey(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.GetUserPublicKey: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	GetUserPublicKeyRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

GetUserPublicKeyReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetValue

GetValueReply GetValue (GetValueRequest body, string authorization, string xCircleAppkey)

getValue

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class GetValueExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new GetValueRequest(); // GetValueRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // getValue
                GetValueReply result = apiInstance.GetValue(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.GetValue: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	GetValueRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

GetValueReply

InviteReply

Stashed changes

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

JoinTopic

<<<<<<< Updated upstream

JoinTopicReply JoinTopic (JoinTopicRequest body, string authorization, string xCircleAppkey)

joinTopic

Joins an existing topic in a Circle.

=======

JoinTopicReply JoinTopic (JoinTopicRequest body, string xCircleAppkey)

joinTopic

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class JoinTopicExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new JoinTopicRequest(); // JoinTopicRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // joinTopic
<<<<<<< Updated upstream
                JoinTopicReply result = apiInstance.JoinTopic(body, authorization, xCircleAppkey);
=======
                JoinTopicReply result = apiInstance.JoinTopic(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.JoinTopic: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	JoinTopicRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

JoinTopicReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LeaveTopic

<<<<<<< Updated upstream

LeaveTopicReply LeaveTopic (LeaveTopicRequest body, string authorization, string xCircleAppkey)

leaveTopic

Leave ('unjoin') a Topic.

=======

LeaveTopicReply LeaveTopic (LeaveTopicRequest body, string xCircleAppkey)

leaveTopic

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class LeaveTopicExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new LeaveTopicRequest(); // LeaveTopicRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // leaveTopic
<<<<<<< Updated upstream
                LeaveTopicReply result = apiInstance.LeaveTopic(body, authorization, xCircleAppkey);
=======
                LeaveTopicReply result = apiInstance.LeaveTopic(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.LeaveTopic: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	LeaveTopicRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

LeaveTopicReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README] <<<<<<< Updated upstream

LockUser

LockUserReply LockUser (LockUserRequest body, string authorization, string xCircleAppkey)

lockUser

Lock the member requesting this action.

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class LockUserExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new LockUserRequest(); // LockUserRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // lockUser
                LockUserReply result = apiInstance.LockUser(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.LockUser: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	LockUserRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

LockUserReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LoginWithCircle

LoginWithCircleReply LoginWithCircle (LoginWithCircleRequest body, string authorization, string xCircleAppkey)

LoginWithCircle

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class LoginWithCircleExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new LoginWithCircleRequest(); // LoginWithCircleRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // LoginWithCircle
                LoginWithCircleReply result = apiInstance.LoginWithCircle(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.LoginWithCircle: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	LoginWithCircleRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

LoginWithCircleReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LogintoService

LogintoServiceReply LogintoService (LogintoServiceRequest body = null, string authorization = null, string xCircleAppkey = null)

logintoService

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class LogintoServiceExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new LogintoServiceRequest(); // LogintoServiceRequest |  (optional) 
            var authorization = authorization_example;  // string | Authorization Bearer (optional) 
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey` (optional) 

            try
            {
                // logintoService
                LogintoServiceReply result = apiInstance.LogintoService(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.LogintoService: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	LogintoServiceRequest		[optional]
authorization	string	Authorization Bearer	[optional]
xCircleAppkey	string	Application `appKey`	[optional]

Return type

LogintoServiceReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ProcessInvite

ProcessInviteReply ProcessInvite (ProcessInviteRequest body, string authorization, string xCircleAppkey)

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.

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class ProcessInviteExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new ProcessInviteRequest(); // ProcessInviteRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // processInvite
                ProcessInviteReply result = apiInstance.ProcessInvite(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.ProcessInvite: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	ProcessInviteRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

ProcessInviteReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveMember

RemoveMemberReply RemoveMember (RemoveMemberRequest body, string authorization, string xCircleAppkey)

removeMember

Removes a member from a Circle. Can be used to remove yourself.

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class RemoveMemberExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new RemoveMemberRequest(); // RemoveMemberRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // removeMember
                RemoveMemberReply result = apiInstance.RemoveMember(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.RemoveMember: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	RemoveMemberRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

RemoveMemberReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveMemberFromTopic

RemoveMemberFromTopicReply RemoveMemberFromTopic (RemoveMemberFromTopicRequest body, string authorization, string xCircleAppkey)

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.

=======

RemoveMemberFromTopic

RemoveMemberFromTopicReply RemoveMemberFromTopic (RemoveMemberFromTopicRequest body, string xCircleAppkey)

removeMemberFromTopic

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class RemoveMemberFromTopicExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new RemoveMemberFromTopicRequest(); // RemoveMemberFromTopicRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // removeMemberFromTopic
<<<<<<< Updated upstream
                RemoveMemberFromTopicReply result = apiInstance.RemoveMemberFromTopic(body, authorization, xCircleAppkey);
=======
                RemoveMemberFromTopicReply result = apiInstance.RemoveMemberFromTopic(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.RemoveMemberFromTopic: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	RemoveMemberFromTopicRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

RemoveMemberFromTopicReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RenameFile

<<<<<<< Updated upstream

RenameFileReply RenameFile (RenameFileRequest body, string authorization, string xCircleAppkey)

renameFile

Renames the desired file.

=======

RenameFileReply RenameFile (RenameFileRequest body, string xCircleAppkey)

renameFile

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class RenameFileExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new RenameFileRequest(); // RenameFileRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // renameFile
<<<<<<< Updated upstream
                RenameFileReply result = apiInstance.RenameFile(body, authorization, xCircleAppkey);
=======
                RenameFileReply result = apiInstance.RenameFile(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.RenameFile: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	RenameFileRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

RenameFileReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokeDevice

<<<<<<< Updated upstream

RevokeDeviceReply RevokeDevice (RevokeDeviceRequest body, string authorization, string xCircleAppkey)

revokeDevice

Removes and wipes a device from the intended Circle.

=======

RevokeDeviceReply RevokeDevice (RevokeDeviceRequest body, string xCircleAppkey)

revokeDevice

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class RevokeDeviceExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new RevokeDeviceRequest(); // RevokeDeviceRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // revokeDevice
<<<<<<< Updated upstream
                RevokeDeviceReply result = apiInstance.RevokeDevice(body, authorization, xCircleAppkey);
=======
                RevokeDeviceReply result = apiInstance.RevokeDevice(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.RevokeDevice: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	RevokeDeviceRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

RevokeDeviceReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokeInvite

<<<<<<< Updated upstream

RevokeInviteReply RevokeInvite (RevokeInviteRequest body, string authorization, string xCircleAppkey)

revokeInvite

Removes a pending invitation to a Circle. If the Invite has been accepted, use RevokeDevice() instead.

=======

RevokeInviteReply RevokeInvite (RevokeInviteRequest body, string xCircleAppkey)

revokeInvite

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class RevokeInviteExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new RevokeInviteRequest(); // RevokeInviteRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // revokeInvite
<<<<<<< Updated upstream
                RevokeInviteReply result = apiInstance.RevokeInvite(body, authorization, xCircleAppkey);
=======
                RevokeInviteReply result = apiInstance.RevokeInvite(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.RevokeInvite: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	RevokeInviteRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

RevokeInviteReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README] <<<<<<< Updated upstream

SecureContents

SecureContentsReply SecureContents (SecureContentsRequest body, string authorization, string xCircleAppkey)

SecureContents

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class SecureContentsExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new SecureContentsRequest(); // SecureContentsRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // SecureContents
                SecureContentsReply result = apiInstance.SecureContents(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.SecureContents: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	SecureContentsRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

SecureContentsReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SecureFile

SecureFileReply SecureFile (SecureFileRequest body, string authorization, string xCircleAppkey)

SecureFile

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class SecureFileExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new SecureFileRequest(); // SecureFileRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // SecureFile
                SecureFileReply result = apiInstance.SecureFile(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.SecureFile: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	SecureFileRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

SecureFileReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceStatus

ServiceStatusReply ServiceStatus (ServiceStatusRequest body)

serviceStatus

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class ServiceStatusExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new ServiceStatusRequest(); // ServiceStatusRequest | 

            try
            {
                // serviceStatus
                ServiceStatusReply result = apiInstance.ServiceStatus(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.ServiceStatus: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	ServiceStatusRequest

Return type

ServiceStatusReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetUserId

SetUserIdReply SetUserId (SetUserIdRequest body, string authorization, string xCircleAppkey)

SetUserId

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class SetUserIdExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new SetUserIdRequest(); // SetUserIdRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // SetUserId
                SetUserIdReply result = apiInstance.SetUserId(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.SetUserId: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	SetUserIdRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

SetUserIdReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SignDataWithCircleKey

SignDataWithCircleKeyReply SignDataWithCircleKey (SignDataWithCircleKeyRequest body, string authorization, string xCircleAppkey)

SignDataWithCircleKey

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class SignDataWithCircleKeyExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new SignDataWithCircleKeyRequest(); // SignDataWithCircleKeyRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // SignDataWithCircleKey
                SignDataWithCircleKeyReply result = apiInstance.SignDataWithCircleKey(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.SignDataWithCircleKey: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	SignDataWithCircleKeyRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

SignDataWithCircleKeyReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SignDataWithUserKey

SignDataWithUserKeyReply SignDataWithUserKey (SignDataWithUserKeyRequest body, string authorization, string xCircleAppkey)

SignDataWithUserKey

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class SignDataWithUserKeyExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new SignDataWithUserKeyRequest(); // SignDataWithUserKeyRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // SignDataWithUserKey
                SignDataWithUserKeyReply result = apiInstance.SignDataWithUserKey(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.SignDataWithUserKey: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	SignDataWithUserKeyRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

SignDataWithUserKeyReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StoreToken

StoreTokenReply StoreToken (StoreTokenRequest body = null, string authorization = null, string xCircleAppkey = null)

storeToken

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class StoreTokenExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new StoreTokenRequest(); // StoreTokenRequest |  (optional) 
            var authorization = authorization_example;  // string | Authorization Bearer (optional) 
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey` (optional) 

            try
            {
                // storeToken
                StoreTokenReply result = apiInstance.StoreToken(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.StoreToken: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	StoreTokenRequest		[optional]
authorization	string	Authorization Bearer	[optional]
xCircleAppkey	string	Application `appKey`	[optional]

Return type

StoreTokenReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnlockUser

UnlockUserReply UnlockUser (UnlockUserRequest body, string authorization, string xCircleAppkey)

unlockUser

Unlock the member requesting this action.

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class UnlockUserExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new UnlockUserRequest(); // UnlockUserRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // unlockUser
                UnlockUserReply result = apiInstance.UnlockUser(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.UnlockUser: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	UnlockUserRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

UnlockUserReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTopic

UpdateTopicReply UpdateTopic (UpdateTopicRequest body, string authorization, string xCircleAppkey)

updateTopic

Updates the name and description of an existing topic.

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class UpdateTopicExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new UpdateTopicRequest(); // UpdateTopicRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // updateTopic
                UpdateTopicReply result = apiInstance.UpdateTopic(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.UpdateTopic: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	UpdateTopicRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

UpdateTopicReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UploadFile

UploadFileReply UploadFile (UploadFileRequest body, string authorization, string xCircleAppkey)

uploadFile

Upload a file with content. This method is available in the CircleService and not needed in CoreL2

Example

using System;
using System.Diagnostics;
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;

namespace Example
{
    public class UploadFileExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new UploadFileRequest(); // UploadFileRequest | 
            var authorization = authorization_example;  // string | Authorization Bearer
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // uploadFile
                UploadFileReply result = apiInstance.UploadFile(body, authorization, xCircleAppkey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.UploadFile: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	UploadFileRequest
authorization	string	Authorization Bearer
xCircleAppkey	string	Application `appKey`

Return type

UploadFileReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WhoAmI

WhoAmIReply WhoAmI (WhoAmIRequest body, string authorization, string xCircleAppkey)

whoAmI

Provides the member ID and the list of the member’s joined devices.

=======

WhoAmI

WhoAmIReply WhoAmI (WhoAmIRequest body, string xCircleAppkey)

whoAmI

Stashed changes

Example

using System;
using System.Diagnostics;
<<<<<<< Updated upstream
using CircleSDK.Api;
using CircleSDK.Client;
using CircleSDK.Model;
=======
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
>>>>>>> Stashed changes

namespace Example
{
    public class WhoAmIExample
    {
        public void main()
        {
            var apiInstance = new CircleApi();
            var body = new WhoAmIRequest(); // WhoAmIRequest | 
<<<<<<< Updated upstream
            var authorization = authorization_example;  // string | Authorization Bearer
=======
>>>>>>> Stashed changes
            var xCircleAppkey = xCircleAppkey_example;  // string | Application `appKey`

            try
            {
                // whoAmI
<<<<<<< Updated upstream
                WhoAmIReply result = apiInstance.WhoAmI(body, authorization, xCircleAppkey);
=======
                WhoAmIReply result = apiInstance.WhoAmI(body, xCircleAppkey);
>>>>>>> Stashed changes
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CircleApi.WhoAmI: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
body	WhoAmIRequest
<<<<<<< Updated upstream
authorization	string	Authorization Bearer

=======

Stashed changes xCircleAppkey | string| Application `appKey` |

Return type

WhoAmIReply

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

136 KiB Raw Permalink Blame History

CircleSDK.Api.CircleApi

IO.Swagger.Api.CircleApi

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).

AddFile

Example

Parameters

Return type

Authorization

HTTP request headers

AddMemberToTopic

Example

Parameters

Return type

Authorization

HTTP request headers

AddMessage

Adds a message to the desired topic.

AddMessge

Example

Parameters

Return type

Authorization

HTTP request headers

AddValue

Example

Parameters

Return type

Authorization

HTTP request headers

ApproveCoTInvoke

Example

Parameters

Return type

ApproveCoTInvokeReply

Authorization

HTTP request headers

Authorize

Example

Parameters

Return type

<<<<<<< Updated upstream AppAuthorizationReply

Authorization

HTTP request headers

Background

Example

Parameters

Return type

Authorization

HTTP request headers

ConfigureService

Example

Parameters

Return type

Authorization

HTTP request headers

CreateCircle

CreateCircle

Example

Parameters

Return type

Authorization

HTTP request headers

CreateTopic

Example

Parameters

Return type

Authorization

HTTP request headers

Decrypt

Decrypt base64 data using a Circle/Topic encryption key.

DecryptFile

Example

Parameters

Return type

Authorization

HTTP request headers

DefineCircleOfTrust

Example

136 KiB

Raw Permalink Blame History