Skip to content

Latest commit

 

History

History
222 lines (183 loc) · 5.9 KB

events.md

File metadata and controls

222 lines (183 loc) · 5.9 KB
Raw

Recents Widget - Events

messages:created

New message is received in a Space

{
  resource: 'messages',
  event: 'created',
  actorId: 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xZjdkZTVjYi04NTYxLTQ2NzEtYmMwMy1iYzk3NDMxNDQ0MmQ',
  data: {
    id: 'Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk',
    roomId: 'Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0',
    roomType: 'group',
    toPersonId: 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX',
    toPersonEmail: '[email protected]',
    text: 'This is a test',
    html: 'This is a <b>test</b>',
    files: [ 'http://www.example.com/images/media.png' ],
    personId: 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY',
    personEmail: '[email protected]',
    created: '2015-10-18T14:26:16+00:00',
    mentionedPeople: []
  }
}

rooms:unread

There are unread messages in a Space. This event will not fire if the authenticated user is the one who sent the message.

{
  resource: 'rooms',
  event: 'unread',
  data: {
    id: 'Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0',
    title: 'Project Unicorn - Sprint 0',
    type: 'group',
    isLocked: true,
    teamId: 'Y2lzY29zcGFyazovL3VzL1JPT00vNjRlNDVhZTAtYzQ2Yi0xMWU1LTlkZjktMGQ0MWUzNDIxOTcz',
    lastActivity: '2016-04-21T19:12:48.920Z',
    created: '2016-04-21T19:01:55.966Z'
  }
}

rooms:read

A previously unread room is now fully read.

  resource: 'rooms',
  event: 'read',
  data: {
    id: 'Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0',
    title: 'Project Unicorn - Sprint 0',
    type: 'group',
    isLocked: true,
    teamId: 'Y2lzY29zcGFyazovL3VzL1JPT00vNjRlNDVhZTAtYzQ2Yi0xMWU1LTlkZjktMGQ0MWUzNDIxOTcz',
    lastActivity: '2016-04-21T19:12:48.920Z',
    created: '2016-04-21T19:01:55.966Z'
  }
}

rooms:selected

The user selected a room in the recents list or search results.

{
  resource: 'rooms',
  event: 'selected',
  data: {
    id: 'Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0',
    title: 'Project Unicorn - Sprint 0',
    type: 'group',
    isLocked: true,
    teamId: 'Y2lzY29zcGFyazovL3VzL1JPT00vNjRlNDVhZTAtYzQ2Yi0xMWU1LTlkZjktMGQ0MWUzNDIxOTcz',
    lastActivity: '2016-04-21T19:12:48.920Z',
    created: '2016-04-21T19:01:55.966Z',
    toPersonEmail: '[email protected]'
  }
}

rooms:selected (Call Button)

This event fires when the user selects the green call or (join call) button next a space.

{
  resource: 'rooms',
  event: 'selected',
  action: 'call',
  data: {
    id: 'Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0',
    title: 'Project Unicorn - Sprint 0',
    type: 'group',
    isLocked: true,
    teamId: 'Y2lzY29zcGFyazovL3VzL1JPT00vNjRlNDVhZTAtYzQ2Yi0xMWU1LTlkZjktMGQ0MWUzNDIxOTcz',
    lastActivity: '2016-04-21T19:12:48.920Z',
    created: '2016-04-21T19:01:55.966Z'
  }
}

calls:created

The user has either initiated a call or is receiving an incoming call.

{
  resource: 'calls',
  event: 'created',
  actorId: 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xZjdkZTVjYi04NTYxLTQ2NzEtYmMwMy1iYzk3NDMxNDQ0MmQ'
  data: {
    roomId: 'Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0',
    personId: 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY',
    personEmail: '[email protected]',
    call: [Call Object]
  }
}

memberships:created

The user has either created a new space (actorId is yourself) or has been added to an existing space (actorId is someone else).

{
  resource: 'memberships',
  event: 'created',
  actorId: 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xZjdkZTVjYi04NTYxLTQ2NzEtYmMwMy1iYzk3NDMxNDQ0MmQ',
  data: {
    id: 'Y2lzY29zcGFyazovL3VzL01FTUJFUlNISVAvMGQwYzkxYjYtY2U2MC00NzI1LWI2ZDAtMzQ1NWQ1ZDExZWYzOmNkZTFkZDQwLTJmMGQtMTFlNS1iYTljLTdiNjU1NmQyMjA3Yg',
    roomId: 'Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0',
    personId: 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY',
    personEmail: '[email protected]',
    created: '2015-10-18T14:26:16+00:00'
  }
}

memberships:deleted

The user has either left (actorId is yourself) or has been removed (actorId is someone else) from a space.

{
  resource: 'memberships',
  event: 'deleted',
  actorId: 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xZjdkZTVjYi04NTYxLTQ2NzEtYmMwMy1iYzk3NDMxNDQ0MmQ',
  data: {
    id: 'Y2lzY29zcGFyazovL3VzL01FTUJFUlNISVAvMGQwYzkxYjYtY2U2MC00NzI1LWI2ZDAtMzQ1NWQ1ZDExZWYzOmNkZTFkZDQwLTJmMGQtMTFlNS1iYTljLTdiNjU1NmQyMjA3Yg',
    roomId: 'Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0',
    personId: 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY',
    personEmail: '[email protected]',
    created: '2015-10-18T14:26:16+00:00'
  }
}

notifications:created

A browser notification is created.

{
  resource: 'notifications',
  event: 'created',
  data: {
    notification: [Notification Object]
  }
}

notifications:clicked

A browser notification is clicked.

{
  resource: 'notifications',
  event: 'clicked',
  data: {
    notification: [Notification Object]
  }
}

add:clicked

The add button in the header (controlled by enableAddButton property) was clicked

{}

profile:clicked

The user profile in the header (controlled by enableUserProfile property) was clicked

{
  displayName: "Alice Tester"
  email: "[email protected]"
  id: "7d341ade-9d05-43a2-a27d-f88494b4024f"
  nickName: "Alice"
  orgId: "1eb65fdf-ace3-417f-add1-ad72cae0e10f"
}

user_signout:clicked

The sign out menu item in the profile avatar settings menu (controlled by enableUserProfileMenu property) was clicked

{}