PHP 클래스 LaravelFCM\Message\OptionsBuilder

Class OptionsBuilder
파일 보기 프로젝트 열기: brozot/laravel-fcm 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$collapseKey string
$contentAvailable boolean
$delayWhileIdle boolean
$dryRun boolean
$priority string
$restrictedPackageName string
$timeToLive string

공개 메소드들

메소드 설명
build ( ) : Options build an instance of Options
getCollapseKey ( ) : null | string Get the collapseKey
getPriority ( ) : null | string Get the priority
getRestrictedPackageName ( ) : null | string get restricted package name
getTimeToLive ( ) : null | integer get time to live
isContentAvailable ( ) : boolean is content available
isDelayWhileIdle ( ) : boolean is delay white idle
isDryRun ( ) : boolean is dry run
setCollapseKey ( String $collapseKey ) : OptionsBuilder This parameter identifies a group of messages A maximum of 4 different collapse keys is allowed at any given time.
setContentAvailable ( boolean $contentAvailable ) : OptionsBuilder support only Android and Ios
setDelayWhileIdle ( boolean $delayWhileIdle ) : OptionsBuilder When this parameter is set to true, it indicates that the message should not be sent until the device becomes active.
setDryRun ( boolean $isDryRun ) : OptionsBuilder This parameter, when set to true, allows developers to test a request without actually sending a message.
setPriority ( String $priority ) : OptionsBuilder Sets the priority of the message. Valid values are "normal" and "high." By default, messages are sent with normal priority
setRestrictedPackageName ( string $restrictedPackageName ) : OptionsBuilder This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
setTimeToLive ( integer $timeToLive ) : OptionsBuilder This parameter specifies how long the message should be kept in FCM storage if the device is offline

메소드 상세

build() 공개 메소드

build an instance of Options
public build ( ) : Options
리턴 Options

getCollapseKey() 공개 메소드

Get the collapseKey
public getCollapseKey ( ) : null | string
리턴 null | string

getPriority() 공개 메소드

Get the priority
public getPriority ( ) : null | string
리턴 null | string

getRestrictedPackageName() 공개 메소드

get restricted package name
public getRestrictedPackageName ( ) : null | string
리턴 null | string

getTimeToLive() 공개 메소드

get time to live
public getTimeToLive ( ) : null | integer
리턴 null | integer

isContentAvailable() 공개 메소드

is content available
public isContentAvailable ( ) : boolean
리턴 boolean

isDelayWhileIdle() 공개 메소드

is delay white idle
public isDelayWhileIdle ( ) : boolean
리턴 boolean

isDryRun() 공개 메소드

is dry run
public isDryRun ( ) : boolean
리턴 boolean

setCollapseKey() 공개 메소드

This parameter identifies a group of messages A maximum of 4 different collapse keys is allowed at any given time.
public setCollapseKey ( String $collapseKey ) : OptionsBuilder
$collapseKey String
리턴 OptionsBuilder

setContentAvailable() 공개 메소드

An inactive client app is awoken. On iOS, use this field to represent content-available in the APNS payload. On Android, data messages wake the app by default. On Chrome, currently not supported.
public setContentAvailable ( boolean $contentAvailable ) : OptionsBuilder
$contentAvailable boolean
리턴 OptionsBuilder

setDelayWhileIdle() 공개 메소드

When this parameter is set to true, it indicates that the message should not be sent until the device becomes active.
public setDelayWhileIdle ( boolean $delayWhileIdle ) : OptionsBuilder
$delayWhileIdle boolean
리턴 OptionsBuilder

setDryRun() 공개 메소드

It should only be used for the development
public setDryRun ( boolean $isDryRun ) : OptionsBuilder
$isDryRun boolean
리턴 OptionsBuilder

setPriority() 공개 메소드

Sets the priority of the message. Valid values are "normal" and "high." By default, messages are sent with normal priority
public setPriority ( String $priority ) : OptionsBuilder
$priority String
리턴 OptionsBuilder

setRestrictedPackageName() 공개 메소드

This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
public setRestrictedPackageName ( string $restrictedPackageName ) : OptionsBuilder
$restrictedPackageName string
리턴 OptionsBuilder

setTimeToLive() 공개 메소드

This parameter specifies how long the message should be kept in FCM storage if the device is offline
public setTimeToLive ( integer $timeToLive ) : OptionsBuilder
$timeToLive integer (in second) min:0 max:2419200
리턴 OptionsBuilder

프로퍼티 상세

$collapseKey 보호되어 있는 프로퍼티

protected string $collapseKey
리턴 string

$contentAvailable 보호되어 있는 프로퍼티

protected bool $contentAvailable
리턴 boolean

$delayWhileIdle 보호되어 있는 프로퍼티

protected bool $delayWhileIdle
리턴 boolean

$dryRun 보호되어 있는 프로퍼티

protected bool $dryRun
리턴 boolean

$priority 보호되어 있는 프로퍼티

protected string $priority
리턴 string

$restrictedPackageName 보호되어 있는 프로퍼티

protected string $restrictedPackageName
리턴 string

$timeToLive 보호되어 있는 프로퍼티

protected string $timeToLive
리턴 string