@iabtcf/cmpapi - API Documentation | @iabtcf/cmpapi - API Documentation

Index

Enumerations

Classes

Interfaces

Type aliases

Type aliases

Booleany

Booleany: boolean | 1 | 0

Callback

Callback: TCDataCallback | InAppTCDataCallback | PingCallback | VendorListCallback | RemoveListenerCallback | ErrorCallback | FailCallback

Union type of all command callback function signatures

ErrorCallback

ErrorCallback: function

Type declaration

- (msg: string, success: false): void
- Parameters
  - msg: string
  - success: false
  Returns void

FailCallback

FailCallback: function

Type declaration

- (result: null, success: false): void
- Parameters
  - result: null
  - success: false
  Returns void

GetQueueFunction

GetQueueFunction: function

Type declaration

- (): TcfApiArgs[]
- Returns TcfApiArgs[]

InAppTCDataCallback

InAppTCDataCallback: function

Type declaration

- (IATCData: InAppTCData, success: true): void
- Parameters
  - IATCData: InAppTCData
  - success: true
  Returns void

PageCallHandler

PageCallHandler: function

Type declaration

- (command: string, version: number, callback: function, param?: any): void
- Parameters
  - command: string
  - version: number
  - callback: function
    - - (response?: any, success?: any): void
      - Parameters
        
        Optional response: any
        
        Optional success: any
        
        Returns void
  - Optional param: any
  Returns void

PingCallback

PingCallback: function

Type declaration

- (pingReturn: Ping): void
- Parameters
  - pingReturn: Ping
  Returns void

RemoveListenerCallback

RemoveListenerCallback: function

Type declaration

- (status: boolean): void
- Parameters
  - status: boolean
  Returns void

TCDataCallback

TCDataCallback: function

Type declaration

- (tcData: TCData, success: true): void
- Parameters
  - tcData: TCData
  - success: true
  Returns void

TcfApiArgs

TcfApiArgs: [string, number, Callback, any]

VendorListCallback

VendorListCallback: function

Type declaration

- (gvl: VendorList, success: true): void
- Parameters
  - gvl: VendorList
  - success: true
  Returns void

Generated using TypeDoc