View the Project on GitHub elements-storage/elements-sdk-swift
All URIs are relative to https://elements.local
Method | HTTP request | Description |
---|---|---|
activateSatelliteHost | POST /api/2/rdc/hosts/{id}/activate | |
announceSatelliteHost | POST /api/2/rdc/hosts/announce | |
createSatelliteSession | POST /api/2/rdc/sessions | |
deleteSatelliteSession | DELETE /api/2/rdc/sessions/{id} | |
getAllSatelliteHosts | GET /api/2/rdc/hosts | |
getAllSatelliteSessions | GET /api/2/rdc/sessions | |
getSatelliteHost | GET /api/2/rdc/hosts/{id} | |
getSatelliteSession | GET /api/2/rdc/sessions/{id} |
open class func activateSatelliteHost( id: Int) -> Promise<RDCActivation>
rdc:access
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let id = 987 // Int | A unique integer value identifying this Satellite host.
SatelliteAPI.activateSatelliteHost(id: id).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this Satellite host. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func announceSatelliteHost() -> Promise<RDCHost>
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
SatelliteAPI.announceSatelliteHost().then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
This endpoint does not need any parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func createSatelliteSession( rDCSessionCreate: RDCSessionCreate) -> Promise<RDCSession>
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let rDCSessionCreate = RDCSessionCreate(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example")) // RDCSessionCreate |
SatelliteAPI.createSatelliteSession(rDCSessionCreate: rDCSessionCreate).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
rDCSessionCreate | RDCSessionCreate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func deleteSatelliteSession( id: Int) -> Promise<Void>
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let id = 987 // Int | A unique integer value identifying this Satellite session.
SatelliteAPI.deleteSatelliteSession(id: id).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this Satellite session. |
Void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getAllSatelliteHosts( ordering: String? = nil, limit: Int? = nil, offset: Int? = nil) -> Promise<[RDCHost]>
rdc:access
* License component: rdc// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
SatelliteAPI.getAllSatelliteHosts(ordering: ordering, limit: limit, offset: offset).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
ordering | String | Which field to use when ordering the results. | [optional] |
limit | Int | Number of results to return per page. | [optional] |
offset | Int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getAllSatelliteSessions( ordering: String? = nil, limit: Int? = nil, offset: Int? = nil) -> Promise<[RDCSession]>
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
SatelliteAPI.getAllSatelliteSessions(ordering: ordering, limit: limit, offset: offset).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
ordering | String | Which field to use when ordering the results. | [optional] |
limit | Int | Number of results to return per page. | [optional] |
offset | Int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getSatelliteHost( id: Int) -> Promise<RDCHost>
rdc:access
* License component: rdc// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let id = 987 // Int | A unique integer value identifying this Satellite host.
SatelliteAPI.getSatelliteHost(id: id).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this Satellite host. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getSatelliteSession( id: Int) -> Promise<RDCSession>
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let id = 987 // Int | A unique integer value identifying this Satellite session.
SatelliteAPI.getSatelliteSession(id: id).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this Satellite session. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]