Interface: ConnectedPlayerPayload

Payload used to find connected players.

Table of contents

Properties

• cursor
• filter
• hoursSinceInvitation
• size

Properties

cursor

• Optional cursor: number

Specify where to start fetch the friend list. This parameter only applies when NEW_INVITATIONS_ONLY filter is used. When not specified with NEW_INVITATIONS_ONLY filter, default cursor is 0.

---

filter

• Optional filter: ConnectedPlayerFilter

Filter to be applied to the friend list.

---

hoursSinceInvitation

• Optional hoursSinceInvitation: number

Specify how long a friend should be filtered out after the current player sends him/her a message. This parameter only applies when NEW_INVITATIONS_ONLY filter is used. When not specified, it will filter out any friend who has been sent a message.

---

size

• Optional size: number

Specify how many friends to be returned in the friend list. This parameter only applies when NEW_INVITATIONS_ONLY filter is used. When not specified with NEW_INVITATIONS_ONLY filter, default cursor is 25.