Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OnActivityDownloaded

label

EVENTS

description

An event class that is attached to emitted events as a payload for events with the name oauth.activities.downloaded.

This class can also be used to implement the event emitter.

Parameters:

Name Type Description
slug string The activity's slug as described in Activity.
since

v0.4.0

Hierarchy

  • OnActivityDownloaded

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

slug

slug: string

Contains the activity slug which consists of a unique field in the activities collection. This field can be used to retrieve the activity document.

access

public

var

{string}

Methods

Static create

  • Static helper method that creates an instance of this event class.

    This method can/shall be used whenever an event is emitted by the runtime, or whenever an event is being listened to.

    access

    public

    static

    Parameters

    • slug: string

      The unique activity slug.

    Returns OnActivityDownloaded

    The prepared event (which can be emitted).

Generated using TypeDoc