extension-poki-sdk

Namespace: poki_sdk Language: Lua Type: Extension

Functions and constants for interacting with Poki SDK APIs

API

poki_sdk.gameplay_start

Type: FUNCTION

poki_sdk.gameplay_stop

Type: FUNCTION

poki_sdk.commercial_break

Type: FUNCTION

Parameters

• callback (function)
  • self (object) - The calling script instance
  • status (number) - One of the statuses: poki_sdk.COMMERCIAL_BREAK_START, poki_sdk.COMMERCIAL_BREAK_SUCCESS

poki_sdk.rewarded_break

Type: FUNCTION

Parameters

• size (string) - The size of the reward. Accepted values are small, medium and large. Optional. Default is small.
• callback (function)
  • self (object) - The calling script instance
  • status (number) - One of the statuses: poki_sdk.REWARDED_BREAK_ERROR, poki_sdk.REWARDED_BREAK_START, poki_sdk.REWARDED_BREAK_SUCCESS

poki_sdk.set_debug

Type: FUNCTION

Parameters

• is_debug (boolean)

poki_sdk.capture_error

Type: FUNCTION

Parameters

• error (string)

poki_sdk.shareable_url

Type: FUNCTION

Parameters

• params (table)
• callback (function)

poki_sdk.get_url_param

Type: FUNCTION

Parameters

• key (string)

poki_sdk.measure

Type: FUNCTION

Parameters

• category (string)
• what (string)
• action (string)

poki_sdk.move_pill

Type: FUNCTION

Parameters

• topPercent (number)
• topPx (number)

poki_sdk.get_user

Type: FUNCTION

Parameters

• callback (function)
  • self (object) - The calling script instance
  • user (table) - A table with the fields username and avatar_url, or nil if no user is logged in.
  • error (string) - The rejection message if user accounts are unavailable, or nil otherwise.

poki_sdk.get_token

Type: FUNCTION

Parameters

• callback (function)
  • self (object) - The calling script instance
  • token (string) - The Poki auth token, or nil if no user is logged in.
  • error (string) - The rejection message if user accounts are unavailable, or nil otherwise.

poki_sdk.login

Type: FUNCTION

Parameters

• callback (function)
  • self (object) - The calling script instance
  • success (boolean) - true if the login promise resolved, otherwise false.
  • error (string) - The rejection message on failure, or nil on success.

poki_sdk.open_external_link

Type: FUNCTION

Parameters

• url (string)

COMMERCIAL_BREAK_SUCCESS

Type: VARIABLE

COMMERCIAL_BREAK_START

Type: VARIABLE

REWARDED_BREAK_ERROR

Type: VARIABLE

REWARDED_BREAK_SUCCESS

Type: VARIABLE

REWARDED_BREAK_START

Type: VARIABLE