Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ApiV1

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private config

config: APIV1Config

Optional tokens

tokens: undefined | object

Accessors

login

login:

my

my:

Methods

container

  • container(id: string): object
  • Parameters

    • id: string

    Returns object

    • details: object
      • get: function
        • get(__namedParameters?: object): Promise<any>
        • Parameters

          • Default value __namedParameters: object = {}
            • getAccessLevel: boolean
            • getContainerSettings: boolean

          Returns Promise<any>

form

  • form(id: string): object
  • Parameters

    • id: string

    Returns object

    • auth: function
      • auth(container: string): Promise<any>
    • authLoop: function
      • authLoop(container: string): Timer
    • entries: object
      • recent: function
        • recent(containerId: string, __namedParameters: object): Promise<any>
        • Parameters

          • containerId: string
          • __namedParameters: object
            • _pds: boolean
            • getExportInfo: boolean
            • history: boolean
            • isPublic: boolean
            • outputType: null | string
            • savedViewKey: undefined | string
            • validation: undefined | string

          Returns Promise<any>

group

  • group(id: string): object

room

  • room(id?: undefined | string): object
  • Parameters

    • Optional id: undefined | string

    Returns object

    • decryptionKey: function
      • decryptionKey(): Promise<any>
    • forms: object
      • get: function
        • get(): Promise<any>
    • messages: object
      • get: function
        • get(__namedParameters?: object): Promise<any>
        • Parameters

          • Default value __namedParameters: object = {}
            • after: undefined | number
            • before: number
            • interval: string
            • mode: undefined | string

          Returns Promise<any>

      • message: function
        • message(messageId?: undefined | string): object
        • Parameters

          • Optional messageId: undefined | string

          Returns object

          • send: function
            • send(__namedParameters: object): Promise<any>
            • Parameters

              • __namedParameters: object
                • broadcast: boolean
                • important: boolean
                • isNewThread: undefined | true | false
                • message: string
                • pogis: undefined | string
                • thread: undefined | string
                • threadTitle: undefined | string
                • threadType: undefined | string

              Returns Promise<any>

    • siderooms: object
      • get: function
        • get(): Promise<any>
    • threads: object
      • get: function
        • get(): Promise<any>
      • thread: function
        • thread(threadId: string): object

user

  • user(id: number): object
  • Parameters

    • id: number

    Returns object

    • profilePhotoUrl: function
      • profilePhotoUrl(): string
    • alerts: object
      • acknowledge: function
        • acknowledge(id: string): Promise<any>
      • delete: function
        • delete(id: string): Promise<any>
      • get: function
        • get(): Promise<any>

workflow

  • workflow(id: string): object
  • Parameters

    • id: string

    Returns object

    • auth: function
      • auth(container: string): Promise<any>
    • authLoop: function
      • authLoop(container: string): Timer

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc