Options
All
  • Public
  • Public/Protected
  • All
Menu

@dronedeploy/rocos-js

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AnyActionType

AnyActionType: service | command | sendMessage

DateFieldType

DateFieldType: "dateCreated" | "dateReceived"

ISubscriptionsDifference

ISubscriptionsDifference: { toAdd: ISubscriptionsDifferenceRecord; toRemove: ISubscriptionsDifferenceRecord }

Type declaration

ISubscriptionsDifferenceRecord

ISubscriptionsDifferenceRecord: { callsigns: string[]; sources: any }

Type declaration

  • callsigns: string[]
  • sources: any

InvitationType

InvitationType: "PROJECT" | "SIGNUP"

RocosChangeMessageType

RocosChangeMessageType: "token" | "user-token"

Variables

Const FAST_LANE_MESSAGE_TIMEOUT_SEC

FAST_LANE_MESSAGE_TIMEOUT_SEC: number = 5 + 5

Timeout for fast lane messages.

Const GR_PLATFORM_TIME_TTL

GR_PLATFORM_TIME_TTL: number = 30 * 60 * 1000

Const KEY_GR_LAST_PLATFORM_TIME_SYNCED_AT

KEY_GR_LAST_PLATFORM_TIME_SYNCED_AT: "gr_lastPlatformTimeSyncedAt" = "gr_lastPlatformTimeSyncedAt"

Const KEY_GR_PLATFORM_TIME_OFFSET

KEY_GR_PLATFORM_TIME_OFFSET: "gr_platformTimeOffset" = "gr_platformTimeOffset"

Const MAX_CLIENT_WAITING_TIME_STANDARD_DEVIATION_ALLOWED

MAX_CLIENT_WAITING_TIME_STANDARD_DEVIATION_ALLOWED: 100 = 100

Const NUMBER_OF_SERVER_TIME_USED_TO_CALIBRATE

NUMBER_OF_SERVER_TIME_USED_TO_CALIBRATE: 5 = 5

Object literals

Const config

config: object

baseURL

baseURL: string = "https://api-c32e9204c569.rocos.io"

gRPCBackEnd

gRPCBackEnd: string = "https://api.rocos.io"

endPoints

endPoints: object

login

login: string = "/users/auth"

passwordReset

passwordReset: string = "/users/forgotten-password-reset"

signup

signup: string = "/users"

account

account: object

create

  • create(): string

details

  • details(accountId: string): string

integrations

  • integrations(accountId: string): string

integrationsById

  • integrationsById(accountId: string, integrationId: string): string

integrationsByType

  • integrationsByType(accountId: string, integrationId: string, integrationType: string): string

  • Parameters

    • accountId: string
    • integrationId: string
    • integrationType: string

    Returns string

settings

  • settings(accountId: string): string

admin

admin: object

sendInvitation

  • sendInvitation(): string

application

application: object

auth

  • auth(): string

create

  • create(accountId: string, projectId: string): string

delete

  • delete(accountId: string, projectId: string, applicationId: string): string

  • Parameters

    • accountId: string
    • projectId: string
    • applicationId: string

    Returns string

getAll

  • getAll(accountId: string, projectId: string): string

getOne

  • getOne(accountId: string, projectId: string, applicationId: string): string

  • Parameters

    • accountId: string
    • projectId: string
    • applicationId: string

    Returns string

update

  • update(accountId: string, projectId: string, applicationId: string): string

  • Parameters

    • accountId: string
    • projectId: string
    • applicationId: string

    Returns string

assetStorage

assetStorage: object

create

  • create(projectId: string, filePath: string): string

delete

  • delete(projectId: string, filePath: string): string

get

  • get(projectId: string, filePath: string): string

list

  • list(projectId: string): string

listFlowAssets

  • listFlowAssets(projectId: string, flowId: string, instanceId: string, parent: string, includeSignedUrl: boolean): string

  • Parameters

    • projectId: string
    • flowId: string
    • instanceId: string
    • parent: string
    • includeSignedUrl: boolean

    Returns string

listRobotAssets

  • listRobotAssets(projectId: string, callsign: string, parent: string, includeSignedUrl: boolean): string

  • Parameters

    • projectId: string
    • callsign: string
    • parent: string
    • includeSignedUrl: boolean

    Returns string

profileSyncDefinitions

  • profileSyncDefinitions(projectId: string, profileId: string): string

robotSyncDefinitions

  • robotSyncDefinitions(projectId: string, callsign: string): string

update

  • update(projectId: string, filePath: string): string

configGroup

configGroup: object

create

  • create(projectId: string, type: string): string

getByVersion

  • getByVersion(projectId: string, type: string, id: string, version: string): string

  • Parameters

    • projectId: string
    • type: string
    • id: string
    • version: string

    Returns string

getOverrideConfig

  • getOverrideConfig(projectId: string, type: string, id: string, ownerId: string): string

  • Parameters

    • projectId: string
    • type: string
    • id: string
    • ownerId: string

    Returns string

info

  • info(projectId: string, type: string, id: string): string

list

  • list(projectId: string, type: string): string

overrideByOwnerId

  • overrideByOwnerId(projectId: string, type: string, id: string, ownerId: string): string

  • Parameters

    • projectId: string
    • type: string
    • id: string
    • ownerId: string

    Returns string

publish

  • publish(projectId: string, type: string, id: string): string

update

  • update(projectId: string, type: string, id: string): string

updateConfig

  • updateConfig(projectId: string, type: string, id: string, configId: string): string

  • Parameters

    • projectId: string
    • type: string
    • id: string
    • configId: string

    Returns string

dashboard

dashboard: object

createDoc

  • createDoc(projId: string, collectionId: string): string

createWidget

  • createWidget(projId: string, dashboardId: string): string

deleteDocs

  • deleteDocs(projId: string, collectionId: string): string

deleteWidgets

  • deleteWidgets(projId: string, dashboardId: string): string

getDocs

  • getDocs(projId: string, collectionId: string): string

info

  • info(projId: string, dashboardId: string): string

data

data: object

exportJobs

  • exportJobs(projectId: string): string

externalProjects

externalProjects: object

list

  • list(accountId: string): string

function

function: object

create

  • create(projectId: string): string

delete

  • delete(projectId: string, id: string): string

info

  • info(projectId: string, id: string): string

list

  • list(projectId: string): string

pods

  • pods(projectId: string, id: string): string

run

  • run(projectId: string, id: string): string

update

  • update(projectId: string, id: string): string

operation

operation: object

createOperation

  • createOperation(projectId: string): string

deleteOperationsForProject

  • deleteOperationsForProject(projectId: string): string

getOperation

  • getOperation(projectId: string, id: string): string

getOperationsForProject

  • getOperationsForProject(projectId: string): string

updateOperation

  • updateOperation(projectId: string, operationId: string): string

otp

otp: object

auth

  • auth(): string

project

project: object

create

create: string = "/projects"

list

list: string = "/projects"

createProjectByTemplate

  • createProjectByTemplate(templateId: string): string

createProjectUnderAccount

  • createProjectUnderAccount(accountId: string): string

delete

  • delete(accountId: string, projectId: string): string

info

  • info(projectId: string): string

projectDashboard

  • projectDashboard(projectId: string): string

projectDashboardCustomWidget

  • projectDashboardCustomWidget(projectId: string, dashboardId: string): string

projectDashboardId

  • projectDashboardId(projectId: string, dashboardId: string): string

projectsUnderAccount

  • projectsUnderAccount(accountId: string): string

update

  • update(projectId: string): string

robot

robot: object

agentSettings

  • agentSettings(projId: string, callsign: string): string

attributes

  • attributes(projId: string, callsign: string): string

buttons

  • buttons(projId: string, callsign: string): string

commands

  • commands(projId: string, callsign: string): string

commandsV2

  • commandsV2(projId: string, callsign: string): string

create

  • create(projId: string): string

dashboardBlobV2

  • dashboardBlobV2(projId: string, callsign: string, id: string): string

dashboardsV2

  • dashboardsV2(projId: string, callsign: string, id: string): string

dataSourcesSchema

  • dataSourcesSchema(): string

delete

  • delete(projId: string): string

eventDefinitions

  • eventDefinitions(projId: string, callsign: string): string

eventHistory

  • eventHistory(projId: string, callsign: string, eventDefinitionId: string): string

  • Parameters

    • projId: string
    • callsign: string
    • eventDefinitionId: string

    Returns string

gamepads

  • gamepads(projId: string, callsign: string): string

info

  • info(projId: string, callsign: string): string

list

  • list(projId: string): string

listRobotDashboardsV2

  • listRobotDashboardsV2(projId: string, callsign: string): string

newRobotDashboardsV2

  • newRobotDashboardsV2(projId: string, callsign: string): string

register

  • register(projId: string, callsign: string): string

settings

  • settings(projId: string, callsign: string): string

templates

  • templates(): string

triggers

  • triggers(projId: string, callsign: string): string

update

  • update(projId: string): string

robotDefs

robotDefs: object

agentSettings

  • agentSettings(projId: string, defId: string): string

buttons

  • buttons(projId: string, defId: string): string

commandActions

  • commandActions(projId: string, defId: string): string

commands

  • commands(projId: string, defId: string): string

commandsV2

  • commandsV2(projId: string, defId: string): string

copy

  • copy(projId: string, defId: string): string

create

  • create(projId: string): string

dashboardBlob

  • dashboardBlob(projId: string, defId: string): string

dashboardBlobV2

  • dashboardBlobV2(projId: string, profileId: string, dashboardId: string): string

dashboards

  • dashboards(projId: string, profiles: string): string

dashboardsV2

  • dashboardsV2(projId: string, profileId: string, id: string): string

deleteOne

  • deleteOne(projId: string, defId: string): string

eventDefinitions

  • eventDefinitions(projId: string, defId: string): string

forRobot

  • forRobot(projId: string, callsign: string): string

gamepads

  • gamepads(projId: string, defId: string): string

getOne

  • getOne(projId: string, defId: string): string

list

  • list(projId: string): string

listDashboardsV2

  • listDashboardsV2(projId: string, profileId: string): string

newDashboardsV2

  • newDashboardsV2(projId: string, profileId: string): string

robotList

  • robotList(projId: string): string

settings

  • settings(projId: string, defId: string): string

streams

  • streams(projId: string, defId: string): string

triggers

  • triggers(projId: string, defId: string): string

updateOne

  • updateOne(projId: string, defId: string): string

schedule

schedule: object

get

  • get(projectId: string, callsign: string): string

update

  • update(projectId: string, callsign: string): string

search

search: object

searchStream

  • searchStream(): string

stream

stream: object

addData

  • addData(projId: string, streamId: string): string

bindRobot

  • bindRobot(projId: string, streamId: string): string

create

  • create(projId: string): string

dataExporterTemplates

  • dataExporterTemplates(): string

info

  • info(projId: string, streamId: string): string

list

  • list(projId: string): string

removeStreamData

  • removeStreamData(projId: string, streamId: string): string

removeStreamDataByIds

  • removeStreamDataByIds(projId: string, streamId: string): string

removeStreams

  • removeStreams(projId: string): string

sourceInfo

  • sourceInfo(sourceId: string): string

sources

  • sources(): string

streamsForRobot

  • streamsForRobot(projId: string, callsign: string): string

unbindRobot

  • unbindRobot(projId: string, streamId: string): string

timeSyncer

timeSyncer: object

serverTime

  • serverTime(): string

user

user: object

info

info: string = "/users"

acceptInvitation

  • acceptInvitation(invitationId: string): string

activateAccount

  • activateAccount(accountId: string): string

checkInvitation

  • checkInvitation(invitationId: string): string

createInvitation

  • createInvitation(): string

createPAT

  • createPAT(): string

deleteInvitations

  • deleteInvitations(): string

forgotPassword

  • forgotPassword(): string

getAllPATs

  • getAllPATs(): string

getOnePAT

  • getOnePAT(token: string): string

getToken

  • getToken(): string

listAccountUsers

  • listAccountUsers(accountId: string): string

listInvitations

  • listInvitations(): string

listProjectUsers

  • listProjectUsers(accountId: string, projectId: string): string

removeAccountAccess

  • removeAccountAccess(accountId: string, userId: string): string

removePATById

  • removePATById(id: string): string

removeProjectAccess

  • removeProjectAccess(accountId: string, projectId: string, userId: string): string

verifyEmail

  • verifyEmail(): string

virtualRobot

virtualRobot: object

deploy

  • deploy(projectId: string, callsign: string): string

deploymentDetails

  • deploymentDetails(projectId: string, callsign: string): string

workflow

workflow: object

create

  • create(projectId: string): string

delete

  • delete(projectId: string, workflowId: string): string

getAll

  • getAll(projectId: string): string

getAllOfRobot

  • getAllOfRobot(projectId: string, callsign: string): string

getDeployedRobots

  • getDeployedRobots(projectId: string, workflowId: string): string

getOne

  • getOne(projectId: string, workflowId: string): string

updateAllForRobot

  • updateAllForRobot(projectId: string, callsign: string): string

updateOne

  • updateOne(projectId: string, workflowId: string): string

grpc

grpc: object

messageTimeoutInSec

messageTimeoutInSec: number = 10

autoReset

autoReset: object

enabled

enabled: boolean = false

messageLimit

messageLimit: number = 100

minimumTime

minimumTime: number = 10

storageKeys

storageKeys: object

token

token: string = "ROCOS_CLIENT_TOKEN"

Generated using TypeDoc