Class OneSDK

constructor

• new OneSDK(): OneSDK

• Returns OneSDK

usePermission

PERM

• get PERM(): {
      COMMENT: "COMMENT";
      CONFIG: "CONFIG";
      META: "META";
      NOTIFICATION: "NOTIFICATION";
      ORDER: "ORDER";
      REACTION: "REACTION";
      SERVICE: "SERVICE";
      SETLIST: "SETLIST";
      USER: "USER";
      WORDPAETY: "WORDPAETY";
      YT_SURVEY: "YT_SURVEY";
  }

• Returns {
      COMMENT: "COMMENT";
      CONFIG: "CONFIG";
      META: "META";
      NOTIFICATION: "NOTIFICATION";
      ORDER: "ORDER";
      REACTION: "REACTION";
      SERVICE: "SERVICE";
      SETLIST: "SETLIST";
      USER: "USER";
      WORDPAETY: "WORDPAETY";
      YT_SURVEY: "YT_SURVEY";
  }

  • Readonly COMMENT: "COMMENT"

  • Readonly CONFIG: "CONFIG"

  • Readonly META: "META"

  • Readonly NOTIFICATION: "NOTIFICATION"

  • Readonly ORDER: "ORDER"

  • Readonly REACTION: "REACTION"

  • Readonly SERVICE: "SERVICE"

  • Readonly SETLIST: "SETLIST"

  • Readonly USER: "USER"

  • Readonly WORDPAETY: "WORDPAETY"

  • Readonly YT_SURVEY: "YT_SURVEY"

config

• get config(): Readonly<OneSDKConfig>

• Returns Readonly<OneSDKConfig>

connected

• get connected(): boolean

• Returns boolean

cancelOrder

• cancelOrder(orderId): Promise<OrderItem[]>

• Parameters

  • orderId: string

  Returns Promise<OrderItem[]>

checkLicensed

• checkLicensed(): Promise<boolean>

• Returns Promise<boolean>

completeOrder

• completeOrder(orderId): Promise<OrderItem[]>

• Parameters

  • orderId: string

  Returns Promise<OrderItem[]>

connect

• connect(): Promise<void>

• Returns Promise<void>

delete

• delete<T>(url, config): Promise<AxiosResponse<any, any>>

• Type Parameters

  • T = any

  Parameters

  • url: string
  • config: AxiosRequestConfig<T>

  Returns Promise<AxiosResponse<any, any>>

get

• get<T>(url, config): Promise<AxiosResponse<any, any>>

• Type Parameters

  • T = any

  Parameters

  • url: string
  • config: AxiosRequestConfig<T>

  Returns Promise<AxiosResponse<any, any>>

getCommentStyle

• getCommentStyle(comment): {
      [key: string]: any;
  }

• Parameters

  • comment: Comment

  Returns {
      [key: string]: any;
  }

  • [key: string]: any

getComments

• getComments(): Promise<Comment[]>

• Returns Promise<Comment[]>

getConfig

• getConfig(): Promise<Config[]>

• Returns Promise<Config[]>

getInfo

• getInfo(): Promise<AppInfo>

• Returns Promise<AppInfo>

getOrders

• getOrders(): Promise<OrderItem[]>

• Returns Promise<OrderItem[]>

getPinnedComment

• getPinnedComment(): Promise<null | Comment>

• Returns Promise<null | Comment>

getServices

• getServices(): Promise<Service[]>

• Returns Promise<Service[]>

getSetList

• getSetList(): Promise<SetListAPIResponse>

• Returns Promise<SetListAPIResponse>

getStyleVariable

• getStyleVariable<T>(name, defaultValue, parser?): T

• Type Parameters

  • T = any

  Parameters

  • name: string
  • defaultValue: T
  • parser: ((val) => T) = ...
    • • (val): T

      • Parameters

        • val: string

        Returns T

  Returns T

getTemplates

• getTemplates(): Promise<TemplateData[]>

• Returns Promise<TemplateData[]>

post

• post<T>(url, config): Promise<AxiosResponse<any, any>>

• Type Parameters

  • T = any

  Parameters

  • url: string
  • config: AxiosRequestConfig<T>

  Returns Promise<AxiosResponse<any, any>>

put

• put<T>(url, config): Promise<AxiosResponse<any, any>>

• Type Parameters

  • T = any

  Parameters

  • url: string
  • config: AxiosRequestConfig<T>

  Returns Promise<AxiosResponse<any, any>>

ready

• ready(): Promise<void>

• Returns Promise<void>

reset

• reset(): void

• Returns void

searchComments

• searchComments(params): Promise<Comment[]>

• Parameters

  • params: {
        comments: string[];
        services: string[];
    }

    • comments: string[]

    • services: string[]

  Returns Promise<Comment[]>

setup

• setup(op?): Promise<void>

• Parameters

  • op: Partial<OneSDKConfig> = {}

  Returns Promise<void>

subscribe

• subscribe<T>(subscriber): number

• Type Parameters

  • T extends Subscriber<SendType>

  Parameters

  • subscriber: T

  Returns number

unsubscribe

• unsubscribe(subscriberId): void

• Parameters

  • subscriberId: number

  Returns void