InvitationServiceInterface

InvitationServiceInterface.php : 24 Copy path

Interface

Service for managing collaboration sessions invitations.

Methods¶

InvitationServiceInterface.php : 53 Copy path

Creates a new invitation.

public createInvitation(InvitationCreateStruct $createStruct) : InvitationInterface

Name	Type	Default value	Description
$createStruct	InvitationCreateStruct	-	-

InvitationServiceInterface.php : 75 Copy path

Deletes an invitation.

public deleteInvitation(InvitationInterface $invitation) : void

Name	Type	Default value	Description
$invitation	InvitationInterface	-	-

InvitationServiceInterface.php : 45 Copy path

Returns invitations matching the given query.

public findInvitations([InvitationQuery|null $query = null ]) : InvitationListInterface

Name	Type	Default value	Description
$query	InvitationQuery\|null	null	-

InvitationServiceInterface.php : 32 Copy path

Returns an invitation with given ID.

public getInvitation(int $id) : InvitationInterface

Name	Type	Default value	Description
$id	int	-	-

InvitationServiceInterface.php : 40 Copy path

Returns an invitation associated with the given participant.

public getInvitationByParticipant(ParticipantInterface $participant) : InvitationInterface

Name	Type	Default value	Description
$participant	ParticipantInterface	-	-

InvitationServiceInterface.php : 64 Copy path

Updates any existing invitation with the given data.

public updateInvitation(InvitationInterface $invitation, InvitationUpdateStruct $updateStruct) : InvitationInterface

Name	Type	Default value	Description
$invitation	InvitationInterface	-	-
$updateStruct	InvitationUpdateStruct	-	-