ISetting
Interface ISetting
Tags
Table of Contents
- canChangeMail() : bool
- canChangeStream() : bool
- getIdentifier() : string
- getName() : string
- getPriority() : int
- isDefaultEnabledMail() : bool
- isDefaultEnabledStream() : bool
Methods
canChangeMail()
public
canChangeMail() : bool
Tags
Return values
bool —True when the option can be changed for the mail
canChangeStream()
public
canChangeStream() : bool
Tags
Return values
bool —True when the option can be changed for the stream
getIdentifier()
public
getIdentifier() : string
Tags
Return values
string —Lowercase a-z and underscore only identifier
getName()
public
getName() : string
Tags
Return values
string —A translated string
getPriority()
public
getPriority() : int
Tags
Return values
int —whether the filter should be rather on the top or bottom of the admin section. The filters are arranged in ascending order of the priority values. It is required to return a value between 0 and 100.
isDefaultEnabledMail()
public
isDefaultEnabledMail() : bool
Tags
Return values
bool —True when the option can be changed for the stream
isDefaultEnabledStream()
public
isDefaultEnabledStream() : bool
Tags
Return values
bool —True when the option can be changed for the stream