Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

metrics.create(eventName: string, data: object)

Creates an event within the bounds of a start and end interaction a metrics event for a given exhibit

Expand
titleExample
Code Block
gumbandSDK.metrics.create('Use_Pressed_Button_1', { buttonType: 'accept', score: 72, isGameOver: false});

...

Expand
titleExample
Code Block
gumbandSDK.metrics.startInteraction()

metrics.createConcurrent(eventName: string, data: object, interactionId?: string): string

This method is identical to the create method except that it attaches an interactionId to each event, so Gumband can tell the difference between events for different, concurrent interactions. It will return the generated interactionId so it can be attached to future events for this interaction.

Expand
titleExample
Code Block
gumbandSDK.metrics.createConcurrent('Use_Pressed_Button_1', { buttonType: 'accept', score: 72, isGameOver: false}, interactionId);

metrics.startConcurrentInteraction(data: object, interactionId?: string): string

This method is identical to the startInteraction method except that it generates and attaches an interactionId to each event, so Gumband can tell the difference between events for different, concurrent interactions. It will return the generated interactionId so it can be attached to future events for this interaction.

Expand
titleExample
Code Block
gumbandSDK.metrics.startConcurrentInteraction({}, interactionId);

metrics.endConcurrentInteraction(data: object, interactionId: string): string

This method is identical to the endInteraction method except that it attaches an interactionId to each event, so Gumband can tell the difference between events for different, concurrent interactions.

Expand
titleExample
Code Block
gumbandSDK.metrics.startConcurrentInteraction({}, interactionId);

Notification

notifications.email(message: string): Promise<void>

...