GetRemoteAccessSession PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(authAws, "AWS_SECRET_KEY")
; Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
CkAuthAws::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "devicefarm")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://devicefarm.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"devicefarm.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; The following code creates the JSON request body.
; The JSON created by this code is shown below.
; Use this online tool to generate code from sample JSON:
; Generate Code to Create JSON
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"arn","string")
; The JSON request body created by the above code:
; {
; "arn": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","DeviceFarm_20150623.GetRemoteAccessSession")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
; The following code parses the JSON response.
; A sample JSON response is shown below the sample code.
; Use this online tool to generate parsing code from sample JSON:
; Generate Parsing Code from JSON
arn.s
deviceArn.s
instanceProfileArn.s
Description.s
instanceProfileName.s
PackageCleanup.i
RebootAfterUse.i
status.s
udid.s
j.i
count_j.i
strVal.s
Arn.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.arn")
BillingMethod.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.billingMethod")
ClientId.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.clientId")
Created.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.created")
DeviceArn.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.arn")
Availability.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.availability")
Carrier.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.carrier")
Architecture.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.cpu.architecture")
Clock.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.device.cpu.clock")
Frequency.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.cpu.frequency")
FleetName.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.fleetName")
FleetType.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.fleetType")
FormFactor.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.formFactor")
HeapSize.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.device.heapSize")
Image.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.image")
Manufacturer.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.manufacturer")
Memory.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.device.memory")
Model.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.model")
ModelId.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.modelId")
Name.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.name")
Os.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.os")
Platform.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.platform")
Radio.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.radio")
RemoteAccessEnabled.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.device.remoteAccessEnabled")
RemoteDebugEnabled.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.device.remoteDebugEnabled")
Height.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.device.resolution.height")
Width.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.device.resolution.width")
Metered.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.deviceMinutes.metered")
Total.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.deviceMinutes.total")
Unmetered.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.deviceMinutes.unmetered")
DeviceUdid.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.deviceUdid")
Endpoint.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.endpoint")
HostAddress.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.hostAddress")
InstanceArn.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.instanceArn")
InteractionMode.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.interactionMode")
Message.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.message")
remoteAccessSessionName.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.name")
remoteAccessSessionRemoteDebugEnabled.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.remoteDebugEnabled")
RemoteRecordAppArn.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.remoteRecordAppArn")
RemoteRecordEnabled.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.remoteRecordEnabled")
Result.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.result")
SkipAppResign.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.skipAppResign")
Started.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.started")
Status.s = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.status")
Stopped.i = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.stopped")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"remoteAccessSession.device.instances")
While i < count_i
CkJsonObject::setCkI(jResp, i)
arn = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.instances[i].arn")
deviceArn = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.instances[i].deviceArn")
instanceProfileArn = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.instances[i].instanceProfile.arn")
Description = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.instances[i].instanceProfile.description")
instanceProfileName = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.instances[i].instanceProfile.name")
PackageCleanup = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.device.instances[i].instanceProfile.packageCleanup")
RebootAfterUse = CkJsonObject::ckIntOf(jResp,"remoteAccessSession.device.instances[i].instanceProfile.rebootAfterUse")
status = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.instances[i].status")
udid = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.instances[i].udid")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"remoteAccessSession.device.instances[i].instanceProfile.excludeAppPackagesFromCleanup")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.instances[i].instanceProfile.excludeAppPackagesFromCleanup[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"remoteAccessSession.device.instances[i].labels")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"remoteAccessSession.device.instances[i].labels[j]")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "remoteAccessSession": {
; "arn": "string",
; "billingMethod": "string",
; "clientId": "string",
; "created": number,
; "device": {
; "arn": "string",
; "availability": "string",
; "carrier": "string",
; "cpu": {
; "architecture": "string",
; "clock": number,
; "frequency": "string"
; },
; "fleetName": "string",
; "fleetType": "string",
; "formFactor": "string",
; "heapSize": number,
; "image": "string",
; "instances": [
; {
; "arn": "string",
; "deviceArn": "string",
; "instanceProfile": {
; "arn": "string",
; "description": "string",
; "excludeAppPackagesFromCleanup": [
; "string"
; ],
; "name": "string",
; "packageCleanup": boolean,
; "rebootAfterUse": boolean
; },
; "labels": [
; "string"
; ],
; "status": "string",
; "udid": "string"
; }
; ],
; "manufacturer": "string",
; "memory": number,
; "model": "string",
; "modelId": "string",
; "name": "string",
; "os": "string",
; "platform": "string",
; "radio": "string",
; "remoteAccessEnabled": boolean,
; "remoteDebugEnabled": boolean,
; "resolution": {
; "height": number,
; "width": number
; }
; },
; "deviceMinutes": {
; "metered": number,
; "total": number,
; "unmetered": number
; },
; "deviceUdid": "string",
; "endpoint": "string",
; "hostAddress": "string",
; "instanceArn": "string",
; "interactionMode": "string",
; "message": "string",
; "name": "string",
; "remoteDebugEnabled": boolean,
; "remoteRecordAppArn": "string",
; "remoteRecordEnabled": boolean,
; "result": "string",
; "skipAppResign": boolean,
; "started": number,
; "status": "string",
; "stopped": number
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
