Copied!

InvitationService

InvitationService.php : 16
Interface

Methods

publiccreateInvitation()

InvitationService.php : 24
public createInvitation(InvitationCreateStruct $createStruct) : Invitation

Parameters

Name Type Default value Description
$createStruct InvitationCreateStruct - -

Return values

Invitation

Tags
Throws
BadStateException
Throws
InvalidArgumentException
Throws
UnauthorizedException
Throws
JsonException

publicfindInvitations()

InvitationService.php : 45
public findInvitations([InvitationFilter|null $invitationsFilter = null ]) : array<string|int, Invitation>

Parameters

Name Type Default value Description
$invitationsFilter InvitationFilter|null null -

Return values

array<string|int, Invitation>

Tags
Throws
BadStateException
Throws
InvalidArgumentException
Throws
UnauthorizedException

publicgetInvitation()

InvitationService.php : 32
public getInvitation(string $hash) : Invitation

Parameters

Name Type Default value Description
$hash string - -

Return values

Invitation

publicgetInvitationByEmail()

InvitationService.php : 34
public getInvitationByEmail(string $email) : Invitation

Parameters

Name Type Default value Description
$email string - -

Return values

Invitation

publicisExpired()

InvitationService.php : 30
public isExpired(Invitation $invitation) : bool

Parameters

Name Type Default value Description
$invitation Invitation - -

Return values

bool

publicisValid()

InvitationService.php : 28
public isValid(Invitation $invitation) : bool

Parameters

Name Type Default value Description
$invitation Invitation - -

Return values

bool

publicmarkAsUsed()

InvitationService.php : 36
public markAsUsed(Invitation $invitation) : void

Parameters

Name Type Default value Description
$invitation Invitation - -

publicrefreshInvitation()

InvitationService.php : 47
public refreshInvitation(Invitation $invitation) : Invitation

Parameters

Name Type Default value Description
$invitation Invitation - -

Return values

Invitation