Class Portex

constructor

• new Portex(config?: SDKConfig): Portex

  Parameters

  • config: SDKConfig = ...

  Returns Portex

webApp

isVerified

• get isVerified(): boolean

  Check if user is verified

  Returns boolean

  Whether user is verified

call

• call<T>(
      path: string,
      options?: PortexRequestOptions,
  ): Promise<PortexResponse<T>>

  Send a request

  Type Parameters

  • T

  Parameters

  • path: string

    Request path
  • options: PortexRequestOptions = {}

    Request options

    • Optionalmethod?: "GET" | "POST" | "PUT" | "DELETE"

    • Optionaldata?: any

    • Optionalheaders?: Record<string, string>

  Returns Promise<PortexResponse<T>>

  Request result

init

• init(): Promise<VerifyResult>

  Initialize SDK and verify user

  Returns Promise<VerifyResult>

  Initialization result

invite

• invite(options: InviteOptions): Promise<InviteResult>

  Invite friends or groups

  Parameters

  • options: InviteOptions

    Invite options

  Returns Promise<InviteResult>

  Invite result

getInviteUrl

• getInviteUrl(options: InviteOptions): Promise<InviteResult>

  Copy invite url

  Parameters

  • options: InviteOptions

    Invite options

  Returns Promise<InviteResult>

  Invite result

getStartParam

• getStartParam(): string

  Get start param from webapp

  Returns string

  Start param

getInvitePayload

• getInvitePayload(key: string): Promise<InvitePayloadResult>

  Get invite payload

  Parameters

  • key: string

    Invite key

  Returns Promise<InvitePayloadResult>

  Invite payload result

pay

• pay(
      options: PaymentOptions,
      callback?: (result: InvoiceClosedResult) => void,
  ): Promise<PaymentResult>

  Initiate payment

  Parameters

  • options: PaymentOptions

    Payment options
  • Optionalcallback: (result: InvoiceClosedResult) => void

  Returns Promise<PaymentResult>

  Payment result

queryOrder

• queryOrder(orderId: number): Promise<OrderResult>

  Query order

  Parameters

  • orderId: number

    Order ID

  Returns Promise<OrderResult>

  Payment result

resumePayment

• resumePayment(
      callback?: (result: InvoiceClosedResult) => void,
  ): Promise<null | PaymentResult>

  Resume payment

  Parameters

  • Optionalcallback: (result: InvoiceClosedResult) => void

    Payment result callback

  Returns Promise<null | PaymentResult>

  Payment result

hasPendingPayment

• hasPendingPayment(): boolean

  Whether there is a pending payment URL

  Returns boolean

  Whether there is a pending payment URL

reportUserSet

• reportUserSet(data?: Object): Promise<boolean>

  Report user set

  Parameters

  • data: Object = {}

    user data

  Returns Promise<boolean>

  boolean - true if success

  Throws

  Error - if failed to report user set

reportTrack

• reportTrack(eventName: string, data?: Object): Promise<boolean>

  Report track

  Parameters

  • eventName: string

    event name
  • data: Object = {}

    report track data

  Returns Promise<boolean>

  boolean - true if success

  Throws

  Error - if failed to report track

saveGameRecord

• saveGameRecord(name: string, record: string): Promise<boolean>

  Save game record

  Parameters

  • name: string
  • record: string

    game record

  Returns Promise<boolean>

  boolean - true if success

  Throws

  Error - if failed to save game record

getGameRecord

• getGameRecord(name: string): Promise<GameRecordResult>

  Get game record

  Parameters

  • name: string

  Returns Promise<GameRecordResult>

  record - game record

  Throws

  Error - if failed to get game record

listGameRecordNames

• listGameRecordNames(): Promise<ListGameRecordNamesResult>

  List game record names

  Returns Promise<ListGameRecordNamesResult>

  record - game record

  Throws

  Error - if failed to get game record

getLeaderboardTopN

• getLeaderboardTopN(
      options: LeaderboardTopNOptions,
  ): Promise<LeaderboardTopNResult>

  Get leaderboard top N

  Parameters

  • options: LeaderboardTopNOptions

    Leaderboard top N options

  Returns Promise<LeaderboardTopNResult>

  Leaderboard top N result

getLeaderboardRank

• getLeaderboardRank(
      options: LeaderboardRankOptions,
  ): Promise<LeaderboardRankResult>

  Get leaderboard rank

  Parameters

  • options: LeaderboardRankOptions

    Leaderboard rank options

  Returns Promise<LeaderboardRankResult>

  Leaderboard rank result

updateUserLeaderboardScore

• updateUserLeaderboardScore(
      options: LeaderboardUpdateUserScoreOptions,
  ): Promise<void>

  Update user leaderboard score

  Parameters

  • options: LeaderboardUpdateUserScoreOptions

    Leaderboard update user score options

  Returns Promise<void>