Constructor: restrictionReason

Back to constructors index

Restriction reason.

Contains the reason why access to a certain object must be restricted. Clients are supposed to deny access to the channel if the platform field is equal to all or to the current platform (ios, android, wp, etc.). Platforms can be concatenated (ios-android, ios-wp), unknown platforms are to be ignored. The text is the error message that should be shown to the user.

Attributes:

Name Type Required Description
platform string Yes Platform identifier (ios, android, wp, all, etc.), can be concatenated with a dash as separator (android-ios, ios-wp, etc)
reason string Yes Restriction reason (porno, terms, etc.)
text string Yes Error message to be shown to the user

Type: RestrictionReason

Example:

$restrictionReason = ['_' => 'restrictionReason', 'platform' => 'string', 'reason' => 'string', 'text' => 'string'];

Or, if you’re into Lua:

restrictionReason={_='restrictionReason', platform='string', reason='string', text='string'}

This site uses cookies, as described in the cookie policy. By clicking on "Accept" you consent to the use of cookies.