Interface IH5PContentType<TParams>
interface IH5PContentType<TParams> {
off: (<TData>(type, listener?) => void);
on: (<TData, TType>(type, listener, thisArg?) => void);
once: (<TData, TType>(type, listener, thisArg?) => void);
params?: TParams;
trigger: (<TData>(event, eventData?, extras?) => void);
triggerXAPI: ((verb, extra) => void);
attach($wrapper): void;
createXAPIEventTemplate<TVerb>(verb, extra): XAPIEvent;
}
off: (<TData>(type, listener?) => void);
on: (<TData, TType>(type, listener, thisArg?) => void);
once: (<TData, TType>(type, listener, thisArg?) => void);
params?: TParams;
trigger: (<TData>(event, eventData?, extras?) => void);
triggerXAPI: ((verb, extra) => void);
attach($wrapper): void;
createXAPIEventTemplate<TVerb>(verb, extra): XAPIEvent;
}
Type Parameters
Hierarchy-Diagram
Legend
class
interface
public property
public method
Hierarchy (view full)
- EventDispatcher
- IH5PContentType
Index
Properties
Methods
Properties
off
Type declaration
Throws
listener must be a function
on
Add new event listener
Throws
listener must be a function
once
Add new event listener that will be fired only once
Throws
listener must be a function
Optional params
trigger
Dispatch event
Type declaration
- <TData>(event, eventData?, extras?): void
Type Parameters
Parameters
- event: unknown
Event object or event type as string
OptionaleventData: TDataCustom event data (used when event type as string is used as first argument)
Optionalextras: {
bubbles?: boolean;
external?: boolean;
}Optionalbubbles?: booleanOptionalexternal?: boolean
Returns void
- event: unknown
triggerXAPI
triggerXAPI: ((verb, extra) => void)
Type declaration
- (verb, extra): void
Parameters
- verb: XAPIVerb
- extra: unknown
Returns void
Methods
attach
- attach($wrapper): void
Parameters
- $wrapper: JQuery<HTMLElement>
Returns void
Remove event listener If no listener is specified, all listeners will be removed