Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FTPToken

CloudAccessToken to be used for FTP/SFTP tokens

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new FTPToken(host: string, sftp?: boolean, port?: number, user?: string, password?: string): FTPToken

  • Parameters

    • host: string

      Host name or IP address of the FTP/SFTP server.

    • sftp: boolean = false

      whether or not to use SFTP; defaults to false

    • Optional port: number

      port number of the FTP/SFTP server; optional

    • Optional user: string

      username for the FTP/SFTP server; optional

    • Optional password: string

      password for the user; optional

    Returns FTPToken

Properties

host

host: string

password

password: undefined | string

port

port: undefined | number

service

service: string

user

user: undefined | string

Methods

asDict

  • asDict(): {}

Static fromAWS

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

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

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[]

Generated using TypeDoc