SDK Method Reference

this page lists the public method names and return types used by sdk version 1 0 0 java methods are synchronous node js service methods return promises client creation operation java node js start builder deviceparkapiclient builder() deviceparkapiclient builder() set url url(string) url(string) or endpoint(string) set credentials credentials(credentials) credentials(credentials) set raw credentials credentials of(clientid, clientsecret) credentialsfrom(clientid, clientsecret) set timeout timeout(integer seconds) timeout(number) or timeoutms(number) build build() build() close client close() await client close() node js additionally supports addheader(name, value) and fetchimplementation(fetch) for controlled integrations and testing devices purpose java signature node js signature list pagedto\<device> list(listdevicesrequest request) list(request? listdevicesrequest) promise\<pagedto\<device>> get by serial device get(string serial) get(serial string) promise\<device> access through client devices() pools purpose java signature node js signature list pagedto\<pool> list(listpoolsrequest request) list(request? listpoolsrequest) promise\<pagedto\<pool>> access through client pools() allocations purpose java signature node js signature list pagedto\<allocation> list(allocationsearchrequest request) list(request? allocationsearchrequest) promise\<pagedto\<allocation>> create allocation create(deviceallocationrequest request) create(request deviceallocationrequest) promise\<allocation> release void delete(string allocationid) delete(allocationid string) promise\<void> access through client allocations() delete releases the reservation; it does not delete a physical device sessions purpose java signature node js signature list pagedto\<session> list(devicesessionrequest request) list(request? devicesessionrequest) promise\<pagedto\<session>> start session start(devicestartsessionrequest request) start(request devicestartsessionrequest) promise\<session> stop void stop(string sessionid) stop(sessionid string) promise\<void> download appium log byte\[] logs(string sessionid) logs(sessionid string) promise\<buffer> list recordings pagedto\<screenrecord> screenrecords(string sessionid, screenrecordpaginationrequest request) screenrecords(sessionid string, request? screenrecordpaginationrequest) promise\<pagedto\<screenrecord>> access through client sessions() applications purpose java signature node js signature list pagedto\<application> list(applicationpaginationrequest request) list(request? applicationpaginationrequest) promise\<pagedto\<application>> standard upload application upload(inputstream filestream, string filename, string version) upload(filestream, filename string, version string) promise\<application> upload with image injection application upload(inputstream filestream, string filename, string version, boolean imageinjection) upload(filestream, filename string, version string, imageinjection? boolean) promise\<application> delete void delete(string filekey) delete(filekey string) promise\<void> access through client applications() node js accepts a node js readablestream or web readablestream for filestream imageinjection defaults to false when enabled, device park applies the configured gadget injection during upload processing request builders builder key methods listdevicesrequestbuilder / listdevicesrequest builder page , size , sortby , direction , addfilter , filters , build listpoolsrequestbuilder / listpoolsrequest builder page , size , sortby , direction , addfilter , filters , build allocationsearchrequestbuilder / allocationsearchrequest builder page , size , sortby , direction , addfilter , filters , build deviceallocationrequestbuilder / deviceallocationrequest builder serial , manufacturer , model , platform , platformversion , devicepoolid , priority , build devicesessionrequestbuilder / devicesessionrequest builder page , size , sortby , direction , addfilter , filters , build devicestartsessionrequestbuilder / devicestartsessionrequest builder allocationid , companypoolid , sessionid , videorecording , user/company metadata, customvideorecordingpath , appiumversion , build screenrecordpaginationrequestbuilder / screenrecordpaginationrequest builder page , size , sortby , direction , addfilter , filters , build applicationpaginationrequestbuilder / applicationpaginationrequest builder page , size , sortby , direction , addfilter , filters , build node js builder classes are created with new java builders are created with the model's static builder() method