LimeSurvey API - Master branch
Back to top  

ParticipantBlacklistHandler

package

Default

Methods

addToBlacklist

addToBlacklist(\Token $token): \LimeSurvey\Datavalueobjects\BlacklistResult

Arguments

$token

\Token

Response

\LimeSurvey\Datavalueobjects\BlacklistResult

Returns the CPDB participant corresponding to the given Token.

getCentralParticipantFromToken(\Token $token): \Participant|null

Arguments

$token

\Token

Response

\Participant|null

Returns true if the token is globally blacklisted

isTokenBlacklisted(\Token $token): boolean

Arguments

$token

\Token

Response

boolean

Marks the participant as "opted out" on all surveys currently present in the system that use tokens

optoutParticipantFromAllSurveys(\Participant $participant): array<mixed,integer>

Arguments

$participant

\Participant

Response

array<mixed,integer>

the list of survey IDs from which the participant was opted out

removeFromBlacklist

removeFromBlacklist(\Token $token): \LimeSurvey\Datavalueobjects\BlacklistResult

Arguments

$token

\Token

Response

\LimeSurvey\Datavalueobjects\BlacklistResult

Removes the participant from all surveys currently present in the system that use tokens

removeParticipantFromAllSurveys(\Participant $participant): array<mixed,integer>

Arguments

$participant

\Participant

Response

array<mixed,integer>

the list of survey IDs from which the participant was removed