Skip to content

InvitePayload

InvitePayload

A utility class for creating invite payloads.

Kind: global class

InvitePayload.create(payload)

Creates an invite object with the given payload.

Kind: static method of InvitePayload

ParamTypeDefaultDescription
payloadObjectThe payload object containing the invite properties.
[payload.maxAge]number86400The maximum age of the invite in seconds.
[payload.maxUses]number | undefinedThe maximum number of times the invite can be used.
[payload.temporary]boolean | undefinedWhether the invite is temporary or not.
[payload.targetType]string | undefinedThe type of target for the invite.
[payload.targetUser]string | undefinedThe ID of the target user for the