Constructor
new Event(client, response)
Instantiate an Event object.
Name | Type | Description |
---|---|---|
client |
Client | The client that is instantiating the object. |
response |
Object | The data for the object. |
- Source:
Members
(private) _client :Client
The client that instantiated this object.
- Client
- Source:
assignment_id :Number
The ID of the assignment that the event refers to.
- Number
- Source:
assignment_title :String
The title of the assignment that the event refers to.
- String
- Source:
assignment_type :String
The type of the assignment that the event refers to.
- String
- Source:
created_at :Number
The timestamp of when the event was created.
- Number
- Source:
event_type :String
The type of event.
- String
- Source:
eventable :Object
Information for what the event refers to.
- Object
- Source:
id :Number
The ID of the event.
- Number
- Source:
parent_forename :String
The forename of the parent who the event refers to.
- String
- Source:
parent_surname :String
The surname of the parent who the event refers to.
- String
- Source:
read :Boolean
Whether or not the event has been read as of yet.
- Boolean
- Source:
recipient_id :Number
The recipient of the event.
- Number
- Source:
student_forename :String
The forename of the student who the event refers to.
- String
- Source:
submission_id :Number
The ID of the submission that the event refers to.
- Number
- Source:
user_id :Number
The ID of the user who created the event.
- Number
- Source:
user_name :String
The name of the user who created the event.
- String
- Source:
Methods
clear() → {Promise.<Event>}
Clear the event.
- Source:
- Type
- Promise.<Event>