AXIAM PHP SDK

NotificationEventType : string
in package

Events that can trigger an admin notification.

An open enum. A value this SDK's copy of the spec does not list decodes to self::Unknown rather than failing the response it arrived in (CONTRACT.md §27.11 rule 1). Its own wire spelling is the empty string, which no server value is, so carrying an unrecognised value back into an update is refused by the server rather than written as a spelling it never used. A match over these cases needs an Unknown arm.

Table of Contents

Cases

AccountLocked  = 'account_locked'
The wire value `account_locked`.
CaCertificateRevoked  = 'ca_certificate_revoked'
The wire value `ca_certificate_revoked`.
CertificateIssued  = 'certificate_issued'
The wire value `certificate_issued`.
CertificateRevoked  = 'certificate_revoked'
The wire value `certificate_revoked`.
LoginFailure  = 'login_failure'
The wire value `login_failure`.
MfaEnrollmentChanged  = 'mfa_enrollment_changed'
The wire value `mfa_enrollment_changed`.
PasswordChanged  = 'password_changed'
The wire value `password_changed`.
PasswordResetRequested  = 'password_reset_requested'
The wire value `password_reset_requested`.
PermissionGranted  = 'permission_granted'
The wire value `permission_granted`.
PermissionRevoked  = 'permission_revoked'
The wire value `permission_revoked`.
RoleAssigned  = 'role_assigned'
The wire value `role_assigned`.
RoleUnassigned  = 'role_unassigned'
The wire value `role_unassigned`.
ServiceAccountCreated  = 'service_account_created'
The wire value `service_account_created`.
ServiceAccountDeleted  = 'service_account_deleted'
The wire value `service_account_deleted`.
Unknown  = ''
A value this SDK's copy of the spec does not list; see the type's summary.
UserCreated  = 'user_created'
The wire value `user_created`.
UserDeleted  = 'user_deleted'
The wire value `user_deleted`.
UserUpdated  = 'user_updated'
The wire value `user_updated`.

Methods

fromWire()  : self
Parses a wire value into a NotificationEventType, mapping an unrecognised one to {@see self::Unknown}.

Cases

Methods

fromWire()

Parses a wire value into a NotificationEventType, mapping an unrecognised one to {@see self::Unknown}.

public static fromWire(string $value) : self

Never throws. A parse error here would fail the whole response the value arrived in, so one unrecognised field of one record would take down the page it was on (§27.11 rule 1). A match over this enum needs an Unknown arm.

Parameters
$value : string
Return values
self
On this page

Search results