Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudAccessToken

Abstract base class for classes used to specify cloud access information for outputting to a cloud service.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

service

service: string

Methods

asDict

  • asDict(): {}

  • The cloud access token as a dict, for building the JSON.

    Returns {}

    dict representation for this cloud access token

    • [key: string]: string | {}

Static fromAWS

  • fromAWS(keyId: string, secretKey: string): AWSToken

  • Create a token from Amazon S3 access key id and secret access key.

    Parameters

    • keyId: string

      AWS access key ID

    • secretKey: string

      AWS secret access key

    Returns AWSToken

    created token

Static fromFTP

  • fromFTP(host: string, port?: number, user?: string, password?: string): FTPToken

  • Create a token from FTP info. When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server. The Cloud Office Print server will then fill in default values.

    Parameters

    • host: string

      host name or IP address

    • Optional port: number

      port to use; optional

    • Optional user: string

      username; optional

    • Optional password: string

      password for username; optional

    Returns FTPToken

    created token

Static fromOAuth

  • fromOAuth(service: string, token: string): OAuthToken

  • Create a token from an OAuth string and service name.

    Parameters

    • service: string

      cloud service

    • token: string

      OAuth access token

    Returns OAuthToken

    created token

Static fromSFTP

  • fromSFTP(host: string, port?: number, user?: string, password?: string): FTPToken

  • Create a token from SFTP info. When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server. The Cloud Office Print server will then fill in default values.

    Parameters

    • host: string

      host name or IP address

    • Optional port: number

      port to use; optional

    • Optional user: string

      username; optional

    • Optional password: string

      password for username; optional

    Returns FTPToken

    created token This is an FTPToken object, with sftp=True passed into the constructor. The only difference with FTP is CloudAccessToken.servicename.

Static listAvailableServices

  • listAvailableServices(): string[]

  • List all available services.

    Returns string[]

    list of available service strings

Generated using TypeDoc