diff --git a/doc/LaravelFCM/FCMManager.md b/doc/LaravelFCM/FCMManager.md index c53f7fc06..36839e3d1 100644 --- a/doc/LaravelFCM/FCMManager.md +++ b/doc/LaravelFCM/FCMManager.md @@ -27,6 +27,7 @@ class **FCMManager** extends Man |---|---|---|---| ||getDefaultDriver()|No description|| ||createHttpDriver()|No description|| +|Container|getContainer()|Get the app container|| ### Details @@ -46,4 +47,19 @@ protected **createHttpDriver**() [at line 15](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMManager.php#L15) + + +### + Container **getContainer**() + +[at line 27](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMManager.php#L27) + +Get the app container + +#### Return Value + +| | | +|---|---| +|Container| + _Generated by [Doctum, a API Documentation generator and fork of Sami](https://github.com/code-lts/doctum)._ \ No newline at end of file diff --git a/doc/LaravelFCM/Message/Options.md b/doc/LaravelFCM/Message/Options.md index a90163bf3..9a35c1815 100644 --- a/doc/LaravelFCM/Message/Options.md +++ b/doc/LaravelFCM/Message/Options.md @@ -35,6 +35,7 @@ class **Options** implements |protected null|string|$restrictedPackageName||| |protected bool|$isDryRun||| |protected bool|$directBootOk||| +|protected string|null|$analyticsLabel||| ### Methods | | | | | @@ -49,7 +50,7 @@ class **Options** implements ### **__construct**([OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md) $builder) -[at line 77](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Options.php#L77) +[at line 84](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Options.php#L84) Options constructor. @@ -63,7 +64,7 @@ Options constructor. ### array **toArray**() -[at line 95](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Options.php#L95) +[at line 103](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Options.php#L103) Transform Option to array. diff --git a/doc/LaravelFCM/Message/OptionsBuilder.md b/doc/LaravelFCM/Message/OptionsBuilder.md index 14cdd493a..0b963d0ba 100644 --- a/doc/LaravelFCM/Message/OptionsBuilder.md +++ b/doc/LaravelFCM/Message/OptionsBuilder.md @@ -34,21 +34,24 @@ Builder for creation of options used by FCM. |protected string|$restrictedPackageName||| |protected bool|$dryRun||| |protected bool|$directBootOk||| +|protected string|null|$analyticsLabel||| ### Methods | | | | | |---|---|---|---| |[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)|setCollapseKey(string $collapseKey)|This parameter identifies a group of messages. A maximum of 4 different collapse keys is allowed at any given time.|| -|[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)|setDirectBootOk(bool $directBootOk)|If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode.|| +|[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)|setDirectBootOk(true $directBootOk)|If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode.|| |[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)|setPriority(string $priority)|Sets the priority of the message. Valid values are "normal" and "high.". By default, messages are sent with normal priority.|| |[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)|setContentAvailable(bool $contentAvailable)|support only Android and Ios.|| -|OptionsBuilder|setMutableContent(bool $isMutableContent)|support iOS 10+|| +|[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)|setMutableContent(bool $isMutableContent)|support iOS 10+|| |[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)|setDelayWhileIdle(bool $delayWhileIdle)|When this parameter is set to true, it indicates that the message should not be sent until the device becomes active.|| |[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)|setTimeToLive(int $timeToLive)|This parameter specifies how long the message should be kept in FCM storage if the device is offline.|| |[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)|setRestrictedPackageName(string $restrictedPackageName)|This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.|| |[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)|setDryRun(bool $isDryRun)**deprecated**|This parameter, when set to true, allows developers to test a request without actually sending a message.|| +|[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)|setFcmOptionsAnalyticsLabel(string $analyticsLabel)|This parameter sets the Analytics label|| |null|string|getCollapseKey()|Get the collapseKey.|| |null|string|getPriority()|Get the priority.|| +|null|string|getFcmOptionsAnalyticsLabel()|Get the Analytics label|| |bool|isContentAvailable()|is content available.|| |bool|isMutableContent()|is mutable content|| |bool|isDelayWhileIdle()|is delay white idle.|| @@ -56,7 +59,7 @@ Builder for creation of options used by FCM. |null|string|getRestrictedPackageName()|get restricted package name.|| |bool|isDryRun()|is dry run.|| |bool|isDirectBootOk()|is direct boot ok|| -|Options|build()|build an instance of Options.|| +|[Options](../../LaravelFCM/Message/Options.md)|build()|build an instance of Options.|| ### Details @@ -65,7 +68,7 @@ Builder for creation of options used by FCM. ### [OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md) **setCollapseKey**(string $collapseKey) -[at line 85](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L85) +[at line 92](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L92) This parameter identifies a group of messages A maximum of 4 different collapse keys is allowed at any given time. @@ -85,9 +88,9 @@ A maximum of 4 different collapse keys is allowed at any given time. ### - [OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md) **setDirectBootOk**(bool $directBootOk) + [OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md) **setDirectBootOk**(true $directBootOk) -[at line 102](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L102) +[at line 109](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L109) If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode. See Support Direct Boot mode (https://developer.android.com/training/articles/direct-boot). @@ -95,7 +98,7 @@ If set to true, messages will be allowed to be delivered to the app while the de | | | | |---|---|---| -|bool|$directBootOk|(only true is valid, do not use for false it is pointless) +|true|$directBootOk|(only true is valid, do not use for false it is pointless) #### Return Value @@ -114,7 +117,7 @@ If set to true, messages will be allowed to be delivered to the app while the de ### [OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md) **setPriority**(string $priority) -[at line 120](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L120) +[at line 127](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L127) Sets the priority of the message. Valid values are "normal" and "high." By default, messages are sent with normal priority. @@ -136,7 +139,7 @@ By default, messages are sent with normal priority. | | | |---|---| -|InvalidOptionsException|| +|[InvalidOptionsException](../../LaravelFCM/Message/Exceptions/InvalidOptionsException.html)|| |[ReflectionException](https://www.php.net/ReflectionException)|| @@ -144,7 +147,7 @@ By default, messages are sent with normal priority. ### [OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md) **setContentAvailable**(bool $contentAvailable) -[at line 142](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L142) +[at line 149](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L149) support only Android and Ios. An inactive client app is awoken. On iOS, use this field to represent content-available in the APNS payload. @@ -166,9 +169,9 @@ On Chrome, currently not supported. ### - OptionsBuilder **setMutableContent**(bool $isMutableContent) + [OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md) **setMutableContent**(bool $isMutableContent) -[at line 158](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L158) +[at line 165](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L165) support iOS 10+ When a notification is sent and this is set to true, the content of the notification can be modified before it is displayed. @@ -183,14 +186,14 @@ the content of the notification can be modified before it is displayed. | | | |---|---| -|OptionsBuilder| +|[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)| ### [OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md) **setDelayWhileIdle**(bool $delayWhileIdle) -[at line 172](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L172) +[at line 179](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L179) When this parameter is set to true, it indicates that the message should not be sent until the device becomes active. @@ -211,7 +214,7 @@ When this parameter is set to true, it indicates that the message should not be ### [OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md) **setTimeToLive**(int $timeToLive) -[at line 188](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L188) +[at line 195](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L195) This parameter specifies how long the message should be kept in FCM storage if the device is offline. @@ -232,14 +235,14 @@ This parameter specifies how long the message should be kept in FCM storage if t | | | |---|---| -|InvalidOptionsException|| +|[InvalidOptionsException](../../LaravelFCM/Message/Exceptions/InvalidOptionsException.html)|| ### [OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md) **setRestrictedPackageName**(string $restrictedPackageName) -[at line 206](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L206) +[at line 213](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L213) This parameter specifies the package name of the application where the registration tokens must match in order to receive the message. (Android only) @@ -260,10 +263,10 @@ This parameter specifies the package name of the application where the registrat ### [OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md) **setDryRun**(bool $isDryRun)**deprecated** -[at line 222](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L222)| | | +[at line 229](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L229)| | | |---|---| **deprecated** -||v1 (https://stackoverflow.com/a/53885050/5155484)| +|v1|(https://stackoverflow.com/a/53885050/5155484)| This parameter, when set to true, allows developers to test a request without actually sending a message. It should only be used for the development. @@ -280,12 +283,39 @@ This parameter, when set to true, allows developers to test a request without ac |---|---| |[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)| + + +### + [OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md) **setFcmOptionsAnalyticsLabel**(string $analyticsLabel) + +[at line 245](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L245) + +This parameter sets the Analytics label + +#### Parameters + +| | | | +|---|---|---| +|string|$analyticsLabel| + +#### Return Value + +| | | +|---|---| +|[OptionsBuilder](../../LaravelFCM/Message/OptionsBuilder.md)| + + +#### See also +| | | +|---|---| +|[https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#AndroidFcmOptions](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#AndroidFcmOptions)| + ### null|string **getCollapseKey**() -[at line 234](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L234) +[at line 257](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L257) Get the collapseKey. @@ -300,7 +330,7 @@ Get the collapseKey. ### null|string **getPriority**() -[at line 244](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L244) +[at line 267](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L267) Get the priority. @@ -310,12 +340,33 @@ Get the priority. |---|---| |null|string| + + +### + null|string **getFcmOptionsAnalyticsLabel**() + +[at line 279](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L279) + +Get the Analytics label + +#### Return Value + +| | | +|---|---| +|null|string| + + +#### See also +| | | +|---|---| +|[https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#AndroidFcmOptions](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#AndroidFcmOptions)| + ### bool **isContentAvailable**() -[at line 254](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L254) +[at line 289](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L289) is content available. @@ -330,7 +381,7 @@ is content available. ### bool **isMutableContent**() -[at line 264](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L264) +[at line 299](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L299) is mutable content @@ -345,7 +396,7 @@ is mutable content ### bool **isDelayWhileIdle**() -[at line 274](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L274) +[at line 309](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L309) is delay white idle. @@ -360,7 +411,7 @@ is delay white idle. ### null|int **getTimeToLive**() -[at line 284](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L284) +[at line 319](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L319) get time to live. @@ -375,7 +426,7 @@ get time to live. ### null|string **getRestrictedPackageName**() -[at line 294](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L294) +[at line 329](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L329) get restricted package name. @@ -390,7 +441,7 @@ get restricted package name. ### bool **isDryRun**() -[at line 304](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L304) +[at line 339](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L339) is dry run. @@ -405,7 +456,7 @@ is dry run. ### bool **isDirectBootOk**() -[at line 314](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L314) +[at line 349](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L349) is direct boot ok @@ -418,9 +469,9 @@ is direct boot ok ### - Options **build**() + [Options](../../LaravelFCM/Message/Options.md) **build**() -[at line 324](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L324) +[at line 359](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L359) build an instance of Options. @@ -428,6 +479,6 @@ build an instance of Options. | | | |---|---| -|Options| +|[Options](../../LaravelFCM/Message/Options.md)| _Generated by [Doctum, a API Documentation generator and fork of Sami](https://github.com/code-lts/doctum)._ \ No newline at end of file diff --git a/doc/LaravelFCM/Message/OptionsPriorities.md b/doc/LaravelFCM/Message/OptionsPriorities.md index 4ba763d9e..9e1371592 100644 --- a/doc/LaravelFCM/Message/OptionsPriorities.md +++ b/doc/LaravelFCM/Message/OptionsPriorities.md @@ -42,7 +42,7 @@ class **OptionsPriorities** [View source](https://github.com/code-lts/Laravel-FC ### static array **getPriorities**() -[at line 347](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L347) +[at line 382](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L382) @@ -64,7 +64,7 @@ static array **getPriorities**() ### static bool **isValid**(string $priority) -[at line 363](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L363) +[at line 398](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L398) check if this priority is supported by fcm. diff --git a/doc/LaravelFCM/Message/PayloadDataBuilder.md b/doc/LaravelFCM/Message/PayloadDataBuilder.md index a43dc5d1b..4db9b4b4e 100644 --- a/doc/LaravelFCM/Message/PayloadDataBuilder.md +++ b/doc/LaravelFCM/Message/PayloadDataBuilder.md @@ -30,18 +30,18 @@ Official google documentation : | | | | | |---|---|---|---| -|PayloadDataBuilder|addData(array $data)|add data to existing data.|| -|PayloadDataBuilder|setData(array $data)|erase data with new data.|| +|[PayloadDataBuilder](../../LaravelFCM/Message/PayloadDataBuilder.md)|addData(array $data)|add data to existing data.|| +|[PayloadDataBuilder](../../LaravelFCM/Message/PayloadDataBuilder.md)|setData(array $data)|erase data with new data.|| ||removeAllData()|Remove all data.|| |array|getData()|return data.|| -|PayloadData|build()|generate a PayloadData.|| +|[PayloadData](../../LaravelFCM/Message/PayloadData.md)|build()|generate a PayloadData.|| ### Details ### - PayloadDataBuilder **addData**(array $data) + [PayloadDataBuilder](../../LaravelFCM/Message/PayloadDataBuilder.md) **addData**(array $data) [at line 26](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadDataBuilder.php#L26) @@ -57,12 +57,12 @@ add data to existing data. | | | |---|---| -|PayloadDataBuilder| +|[PayloadDataBuilder](../../LaravelFCM/Message/PayloadDataBuilder.md)| ### - PayloadDataBuilder **setData**(array $data) + [PayloadDataBuilder](../../LaravelFCM/Message/PayloadDataBuilder.md) **setData**(array $data) [at line 42](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadDataBuilder.php#L42) @@ -78,7 +78,7 @@ erase data with new data. | | | |---|---| -|PayloadDataBuilder| +|[PayloadDataBuilder](../../LaravelFCM/Message/PayloadDataBuilder.md)| @@ -106,7 +106,7 @@ return data. ### - PayloadData **build**() + [PayloadData](../../LaravelFCM/Message/PayloadData.md) **build**() [at line 72](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadDataBuilder.php#L72) @@ -116,6 +116,6 @@ generate a PayloadData. | | | |---|---| -|PayloadData|new PayloadData instance +|[PayloadData](../../LaravelFCM/Message/PayloadData.md)|new PayloadData instance _Generated by [Doctum, a API Documentation generator and fork of Sami](https://github.com/code-lts/doctum)._ \ No newline at end of file diff --git a/doc/LaravelFCM/Message/PayloadNotificationBuilder.md b/doc/LaravelFCM/Message/PayloadNotificationBuilder.md index 34d04f68c..00c78a7ec 100644 --- a/doc/LaravelFCM/Message/PayloadNotificationBuilder.md +++ b/doc/LaravelFCM/Message/PayloadNotificationBuilder.md @@ -44,20 +44,20 @@ Official google documentation : | | | | | |---|---|---|---| ||__construct(string $title = null)|Title must be present on android notification and ios (watch) notification.|| -|PayloadNotificationBuilder|setTitle(string $title)|Indicates notification title. This field is not visible on iOS phones and tablets.|| -|PayloadNotificationBuilder|setBody(string $body)|Indicates notification body text.|| -|PayloadNotificationBuilder|setChannelId(string $channelId)|Set a channel ID for android API >= 26.|| -|PayloadNotificationBuilder|setIcon(string $icon)|Supported Android. Indicates notification icon. example : Sets value to myicon for drawable resource myicon.|| -|PayloadNotificationBuilder|setImage(null|string $image)|Supported Android. Indicates the image that can be displayed in the notification. Supports an url or internal image.|| -|PayloadNotificationBuilder|setSound(string $sound)|Indicates a sound to play when the device receives a notification.|| -|PayloadNotificationBuilder|setBadge(string $badge)|Supported Ios.|| -|PayloadNotificationBuilder|setTag(string $tag)|Supported Android.|| -|PayloadNotificationBuilder|setColor(string $color)|Supported Android.|| -|PayloadNotificationBuilder|setClickAction(string $action)|Indicates the action associated with a user click on the notification.|| -|PayloadNotificationBuilder|setTitleLocationKey(string $titleKey)|Indicates the key to the title string for localization.|| -|PayloadNotificationBuilder|setTitleLocationArgs(mixed $titleArgs)|Indicates the string value to replace format specifiers in the title string for localization.|| -|PayloadNotificationBuilder|setBodyLocationKey(string $bodyKey)|Indicates the key to the body string for localization.|| -|PayloadNotificationBuilder|setBodyLocationArgs(mixed $bodyArgs)|Indicates the string value to replace format specifiers in the body string for localization.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setTitle(string $title)|Indicates notification title. This field is not visible on iOS phones and tablets.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setBody(string $body)|Indicates notification body text.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setChannelId(string $channelId)|Set a channel ID for android API >= 26.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setIcon(string $icon)|Supported Android. Indicates notification icon. example : Sets value to myicon for drawable resource myicon.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setImage(null|string $image)|Supported Android. Indicates the image that can be displayed in the notification. Supports an url or internal image.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setSound(string $sound)|Indicates a sound to play when the device receives a notification.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setBadge(string $badge)|Supported Ios.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setTag(string $tag)|Supported Android.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setColor(string $color)|Supported Android.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setClickAction(string $action)|Indicates the action associated with a user click on the notification.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setTitleLocationKey(string $titleKey)|Indicates the key to the title string for localization.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setTitleLocationArgs(mixed $titleArgs)|Indicates the string value to replace format specifiers in the title string for localization.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setBodyLocationKey(string $bodyKey)|Indicates the key to the body string for localization.|| +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|setBodyLocationArgs(mixed $bodyArgs)|Indicates the string value to replace format specifiers in the body string for localization.|| |null|string|getTitle()|Get title.|| |null|string|getBody()|Get body.|| |null|string|getChannelId()|Get channel id for android api >= 26|| @@ -72,7 +72,7 @@ Official google documentation : |null|string|array|getBodyLocationArgs()|Get BodyLocationArgs.|| |string|getTitleLocationKey()|Get TitleLocationKey.|| |null|string|array|getTitleLocationArgs()|GetTitleLocationArgs.|| -|PayloadNotification|build()|Build an PayloadNotification.|| +|[PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md)|build()|Build an PayloadNotification.|| ### Details @@ -93,7 +93,7 @@ Title must be present on android notification and ios (watch) notification. ### - PayloadNotificationBuilder **setTitle**(string $title) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setTitle**(string $title) [at line 129](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L129) @@ -109,12 +109,12 @@ Indicates notification title. This field is not visible on iOS phones and tablet | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setBody**(string $body) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setBody**(string $body) [at line 143](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L143) @@ -130,12 +130,12 @@ Indicates notification body text. | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setChannelId**(string $channelId) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setChannelId**(string $channelId) [at line 157](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L157) @@ -151,12 +151,12 @@ Set a channel ID for android API >= 26. | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setIcon**(string $icon) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setIcon**(string $icon) [at line 172](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L172) @@ -173,12 +173,12 @@ Indicates notification icon. example : Sets value to myicon for drawable resourc | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setImage**(null|string $image) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setImage**(null|string $image) [at line 188](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L188) @@ -196,12 +196,12 @@ Supports an url or internal image. | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setSound**(string $sound) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setSound**(string $sound) [at line 203](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L203) @@ -217,12 +217,12 @@ Indicates a sound to play when the device receives a notification. Suppor | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setBadge**(string $badge) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setBadge**(string $badge) [at line 219](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L219) @@ -238,12 +238,12 @@ Supported Ios. Indicates the badge on the client app home icon. | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setTag**(string $tag) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setTag**(string $tag) [at line 237](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L237) @@ -261,12 +261,12 @@ If set, and a notification with the same tag is already being shown, the new not | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setColor**(string $color) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setColor**(string $color) [at line 253](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L253) @@ -282,12 +282,12 @@ Supported Android. Indicates color of the icon, expressed in #rrggbb form | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setClickAction**(string $action) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setClickAction**(string $action) [at line 267](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L267) @@ -303,12 +303,12 @@ Indicates the action associated with a user click on the notification. | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setTitleLocationKey**(string $titleKey) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setTitleLocationKey**(string $titleKey) [at line 281](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L281) @@ -324,12 +324,12 @@ Indicates the key to the title string for localization. | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setTitleLocationArgs**(mixed $titleArgs) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setTitleLocationArgs**(mixed $titleArgs) [at line 295](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L295) @@ -345,12 +345,12 @@ Indicates the string value to replace format specifiers in the title string for | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setBodyLocationKey**(string $bodyKey) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setBodyLocationKey**(string $bodyKey) [at line 309](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L309) @@ -366,12 +366,12 @@ Indicates the key to the body string for localization. | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder ### - PayloadNotificationBuilder **setBodyLocationArgs**(mixed $bodyArgs) + [PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md) **setBodyLocationArgs**(mixed $bodyArgs) [at line 323](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L323) @@ -387,7 +387,7 @@ Indicates the string value to replace format specifiers in the body string for l | | | |---|---| -|PayloadNotificationBuilder|current instance of the builder +|[PayloadNotificationBuilder](../../LaravelFCM/Message/PayloadNotificationBuilder.md)|current instance of the builder @@ -602,7 +602,7 @@ GetTitleLocationArgs. ### - PayloadNotification **build**() + [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) **build**() [at line 475](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadNotificationBuilder.php#L475) @@ -612,6 +612,6 @@ Build an PayloadNotification. | | | |---|---| -|PayloadNotification| +|[PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md)| _Generated by [Doctum, a API Documentation generator and fork of Sami](https://github.com/code-lts/doctum)._ \ No newline at end of file diff --git a/doc/LaravelFCM/Message/Topics.md b/doc/LaravelFCM/Message/Topics.md index bc3aa0f01..4ad9898e9 100644 --- a/doc/LaravelFCM/Message/Topics.md +++ b/doc/LaravelFCM/Message/Topics.md @@ -31,8 +31,8 @@ Create topic or a topic condition | | | | | |---|---|---|---| |[Topics](../../LaravelFCM/Message/Topics.md)|topic(string $first)|Add a topic, this method should be called before any conditional topic.|| -|Topics|orTopic(string|[Closure](https://www.php.net/Closure) $first)|Add a or condition to the precedent topic set.|| -|Topics|andTopic(string|[Closure](https://www.php.net/Closure) $first)|Add a and condition to the precedent topic set.|| +|[Topics](../../LaravelFCM/Message/Topics.md)|orTopic(string|[Closure](https://www.php.net/Closure) $first)|Add a or condition to the precedent topic set.|| +|[Topics](../../LaravelFCM/Message/Topics.md)|andTopic(string|[Closure](https://www.php.net/Closure) $first)|Add a and condition to the precedent topic set.|| |[Topics](../../LaravelFCM/Message/Topics.md)|nest([Closure](https://www.php.net/Closure) $callback, string $condition)|No description|| |array|string|build()|Transform to array.|| |bool|hasOnlyOneTopic()|Check if only one topic was set.|| @@ -63,7 +63,7 @@ Add a topic, this method should be called before any conditional topic. ### - Topics **orTopic**(string|[Closure](https://www.php.net/Closure) $first) + [Topics](../../LaravelFCM/Message/Topics.md) **orTopic**(string|[Closure](https://www.php.net/Closure) $first) [at line 65](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Topics.php#L65) @@ -100,12 +100,12 @@ Add a or condition to the precedent topic set. Parenthesis is a closureTopics](../../LaravelFCM/Message/Topics.md)| ### - Topics **andTopic**(string|[Closure](https://www.php.net/Closure) $first) + [Topics](../../LaravelFCM/Message/Topics.md) **andTopic**(string|[Closure](https://www.php.net/Closure) $first) [at line 99](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Topics.php#L99) @@ -142,7 +142,7 @@ Add a and condition to the precedent topic set. Parenthesis is a closure< | | | |---|---| -|Topics| +|[Topics](../../LaravelFCM/Message/Topics.md)| @@ -185,7 +185,7 @@ Transform to array. | | | |---|---| -|NoTopicProvidedException|| +|[NoTopicProvidedException](../../LaravelFCM/Message/Exceptions/NoTopicProvidedException.html)|| diff --git a/doc/LaravelFCM/Request/Request.md b/doc/LaravelFCM/Request/Request.md index 0e3a4cade..7759b2936 100644 --- a/doc/LaravelFCM/Request/Request.md +++ b/doc/LaravelFCM/Request/Request.md @@ -28,10 +28,10 @@ class **Request** extends [B |protected ClientInterface|$client||from [../../LaravelFCM/Request/BaseRequest.md#property_client](BaseRequest)| |protected array|$config||from [../../LaravelFCM/Request/BaseRequest.md#property_config](BaseRequest)| |protected string|array|$to||| -|protected Options|$options||| -|protected PayloadNotification|$notification||| -|protected PayloadData|$data||| -|protected Topics|null|$topic||| +|protected [Options](../../LaravelFCM/Message/Options.md)|$options||| +|protected [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md)|$notification||| +|protected [PayloadData](../../LaravelFCM/Message/PayloadData.md)|$data||| +|protected [Topics](../../LaravelFCM/Message/Topics.md)|null|$topic||| ### Methods | | | | | diff --git a/doc/LaravelFCM/Response/DownstreamResponse.md b/doc/LaravelFCM/Response/DownstreamResponse.md index 51556449d..4f603d7a1 100644 --- a/doc/LaravelFCM/Response/DownstreamResponse.md +++ b/doc/LaravelFCM/Response/DownstreamResponse.md @@ -60,7 +60,7 @@ class **DownstreamResponse** extends [__construct(ResponseInterface $response, $tokens, Logger $logger)|DownstreamResponse constructor.|| +||__construct(ResponseInterface $response, array|string $tokens, Logger $logger)|DownstreamResponse constructor.|| ||parseResponse(array $responseInJson)|Parse the response.|| ||logResponse()|No description|| ||merge([DownstreamResponse](../../LaravelFCM/Response/DownstreamResponse.md) $response)|Merge two response.|| @@ -78,7 +78,7 @@ class **DownstreamResponse** extends [ ### - **__construct**(ResponseInterface $response, $tokens, Logger $logger) + **__construct**(ResponseInterface $response, array|string $tokens, Logger $logger) [at line 98](https://github.com/code-lts/Laravel-FCM/blob/main/src/Response/DownstreamResponse.php#L98) @@ -88,7 +88,7 @@ DownstreamResponse constructor. | | | | |---|---|---| -|ResponseInterface|$response|||$tokens||Logger|$logger| +|ResponseInterface|$response||array|string|$tokens||Logger|$logger| ### diff --git a/doc/LaravelFCM/Response/GroupResponse.md b/doc/LaravelFCM/Response/GroupResponse.md index c07876f01..5b270f430 100644 --- a/doc/LaravelFCM/Response/GroupResponse.md +++ b/doc/LaravelFCM/Response/GroupResponse.md @@ -46,7 +46,7 @@ class **GroupResponse** extends [__construct(ResponseInterface $response, $to, Logger $logger)|GroupResponse constructor.|| +||__construct(ResponseInterface $response, string $to, Logger $logger)|GroupResponse constructor.|| ||parseResponse(array $responseInJson)|parse the response.|| ||logResponse()|Log the response.|| |int|numberSuccess()|Get the number of device reached with success.|| @@ -58,7 +58,7 @@ class **GroupResponse** extends [ ### - **__construct**(ResponseInterface $response, $to, Logger $logger) + **__construct**(ResponseInterface $response, string $to, Logger $logger) [at line 46](https://github.com/code-lts/Laravel-FCM/blob/main/src/Response/GroupResponse.php#L46) @@ -68,7 +68,7 @@ GroupResponse constructor. | | | | |---|---|---| -|ResponseInterface|$response|||$to||Logger|$logger| +|ResponseInterface|$response||string|$to||Logger|$logger| ### diff --git a/doc/LaravelFCM/Response/TopicResponse.md b/doc/LaravelFCM/Response/TopicResponse.md index a6e177a8c..4a76d5cce 100644 --- a/doc/LaravelFCM/Response/TopicResponse.md +++ b/doc/LaravelFCM/Response/TopicResponse.md @@ -38,7 +38,7 @@ class **TopicResponse** extends [protected bool|$logEnabled||from [../../LaravelFCM/Response/BaseResponse.md#property_logEnabled](BaseResponse)| |protected Logger|$logger|The logger.|from [../../LaravelFCM/Response/BaseResponse.md#property_logger](BaseResponse)| -|protected Topics|$topic||| +|protected [Topics](../../LaravelFCM/Message/Topics.md)|$topic||| |protected string|$messageId||| |protected string|$error||| |protected bool|$needRetry||| diff --git a/doc/LaravelFCM/Sender/FCMGroup.md b/doc/LaravelFCM/Sender/FCMGroup.md index ab18a2c0b..0795f11e5 100644 --- a/doc/LaravelFCM/Sender/FCMGroup.md +++ b/doc/LaravelFCM/Sender/FCMGroup.md @@ -40,7 +40,7 @@ class **FCMGroup** extends [HT | | | | | |---|---|---|---| -||__construct(ClientInterface $client, $url, Logger $logger)|Initializes a new sender object.|from [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender)| +||__construct(ClientInterface $client, string $url, Logger $logger)|Initializes a new sender object.|from [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender)| |null|string|createGroup(string $notificationKeyName, array $registrationIds)|Create a group.|| |null|string|addToGroup(string $notificationKeyName, string $notificationKey, array $registrationIds)|Add registrationIds to an existing group.|| |null|string|removeFromGroup(string $notificationKeyName, string $notificationKey, array $registeredIds)|Remove registeredIds from an existing group.|| @@ -51,7 +51,7 @@ class **FCMGroup** extends [HT ### - **__construct**(ClientInterface $client, $url, Logger $logger)in [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender) + **__construct**(ClientInterface $client, string $url, Logger $logger)in [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender) [at line 37](https://github.com/code-lts/Laravel-FCM/blob/main/src/Sender/HTTPSender.php#L37) @@ -61,7 +61,7 @@ Initializes a new sender object. | | | | |---|---|---| -|ClientInterface|$client|||$url||Logger|$logger| +|ClientInterface|$client||string|$url||Logger|$logger| ### diff --git a/doc/LaravelFCM/Sender/FCMSender.md b/doc/LaravelFCM/Sender/FCMSender.md index 2ec83c6fd..3221d9d66 100644 --- a/doc/LaravelFCM/Sender/FCMSender.md +++ b/doc/LaravelFCM/Sender/FCMSender.md @@ -38,10 +38,10 @@ class **FCMSender** extends [H | | | | | |---|---|---|---| -||__construct(ClientInterface $client, $url, Logger $logger)|Initializes a new sender object.|from [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender)| -|DownstreamResponse|null|sendTo(string|array $to, [Options](../../LaravelFCM/Message/Options.md) $options = null, [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) $notification = null, [PayloadData](../../LaravelFCM/Message/PayloadData.md) $data = null)|send a downstream message to.|| -|GroupResponse|sendToGroup(string|string[] $notificationKey, [Options](../../LaravelFCM/Message/Options.md) $options = null, [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) $notification = null, [PayloadData](../../LaravelFCM/Message/PayloadData.md) $data = null)|Send a message to a group of devices identified with them notification key.|| -|TopicResponse|sendToTopic([Topics](../../LaravelFCM/Message/Topics.md) $topics, [Options](../../LaravelFCM/Message/Options.md) $options = null, [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) $notification = null, [PayloadData](../../LaravelFCM/Message/PayloadData.md) $data = null)|Send message devices registered at a or more topics.|| +||__construct(ClientInterface $client, string $url, Logger $logger)|Initializes a new sender object.|from [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender)| +|[DownstreamResponse](../../LaravelFCM/Response/DownstreamResponse.md)|null|sendTo(string|array $to, [Options](../../LaravelFCM/Message/Options.md) $options = null, [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) $notification = null, [PayloadData](../../LaravelFCM/Message/PayloadData.md) $data = null)|send a downstream message to.|| +|[GroupResponse](../../LaravelFCM/Response/GroupResponse.md)|sendToGroup(string|string[] $notificationKey, [Options](../../LaravelFCM/Message/Options.md) $options = null, [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) $notification = null, [PayloadData](../../LaravelFCM/Message/PayloadData.md) $data = null)|Send a message to a group of devices identified with them notification key.|| +|[TopicResponse](../../LaravelFCM/Response/TopicResponse.md)|sendToTopic([Topics](../../LaravelFCM/Message/Topics.md) $topics, [Options](../../LaravelFCM/Message/Options.md) $options = null, [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) $notification = null, [PayloadData](../../LaravelFCM/Message/PayloadData.md) $data = null)|Send message devices registered at a or more topics.|| |null|ResponseInterface|post([Request](../../LaravelFCM/Request/Request.md) $request)|No description|| @@ -49,7 +49,7 @@ class **FCMSender** extends [H ### - **__construct**(ClientInterface $client, $url, Logger $logger)in [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender) + **__construct**(ClientInterface $client, string $url, Logger $logger)in [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender) [at line 37](https://github.com/code-lts/Laravel-FCM/blob/main/src/Sender/HTTPSender.php#L37) @@ -59,11 +59,11 @@ Initializes a new sender object. | | | | |---|---|---| -|ClientInterface|$client|||$url||Logger|$logger| +|ClientInterface|$client||string|$url||Logger|$logger| ### - DownstreamResponse|null **sendTo**(string|array $to, [Options](../../LaravelFCM/Message/Options.md) $options = null, [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) $notification = null, [PayloadData](../../LaravelFCM/Message/PayloadData.md) $data = null) + [DownstreamResponse](../../LaravelFCM/Response/DownstreamResponse.md)|null **sendTo**(string|array $to, [Options](../../LaravelFCM/Message/Options.md) $options = null, [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) $notification = null, [PayloadData](../../LaravelFCM/Message/PayloadData.md) $data = null) [at line 32](https://github.com/code-lts/Laravel-FCM/blob/main/src/Sender/FCMSender.php#L32) @@ -83,12 +83,12 @@ send a downstream message to.
    | | | |---|---| -|DownstreamResponse|null| +|[DownstreamResponse](../../LaravelFCM/Response/DownstreamResponse.md)|null| ### - GroupResponse **sendToGroup**(string|string[] $notificationKey, [Options](../../LaravelFCM/Message/Options.md) $options = null, [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) $notification = null, [PayloadData](../../LaravelFCM/Message/PayloadData.md) $data = null) + [GroupResponse](../../LaravelFCM/Response/GroupResponse.md) **sendToGroup**(string|string[] $notificationKey, [Options](../../LaravelFCM/Message/Options.md) $options = null, [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) $notification = null, [PayloadData](../../LaravelFCM/Message/PayloadData.md) $data = null) [at line 70](https://github.com/code-lts/Laravel-FCM/blob/main/src/Sender/FCMSender.php#L70) @@ -104,12 +104,12 @@ Send a message to a group of devices identified with them notification key. | | | |---|---| -|GroupResponse| +|[GroupResponse](../../LaravelFCM/Response/GroupResponse.md)| ### - TopicResponse **sendToTopic**([Topics](../../LaravelFCM/Message/Topics.md) $topics, [Options](../../LaravelFCM/Message/Options.md) $options = null, [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) $notification = null, [PayloadData](../../LaravelFCM/Message/PayloadData.md) $data = null) + [TopicResponse](../../LaravelFCM/Response/TopicResponse.md) **sendToTopic**([Topics](../../LaravelFCM/Message/Topics.md) $topics, [Options](../../LaravelFCM/Message/Options.md) $options = null, [PayloadNotification](../../LaravelFCM/Message/PayloadNotification.md) $notification = null, [PayloadData](../../LaravelFCM/Message/PayloadData.md) $data = null) [at line 89](https://github.com/code-lts/Laravel-FCM/blob/main/src/Sender/FCMSender.php#L89) @@ -125,7 +125,7 @@ Send message devices registered at a or more topics. | | | |---|---| -|TopicResponse| +|[TopicResponse](../../LaravelFCM/Response/TopicResponse.md)| diff --git a/doc/LaravelFCM/Sender/FCMTopic.md b/doc/LaravelFCM/Sender/FCMTopic.md index b8b9da3e6..30394ec25 100644 --- a/doc/LaravelFCM/Sender/FCMTopic.md +++ b/doc/LaravelFCM/Sender/FCMTopic.md @@ -40,7 +40,7 @@ class **FCMTopic** extends [HT | | | | | |---|---|---|---| -||__construct(ClientInterface $client, $url, Logger $logger)|Initializes a new sender object.|from [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender)| +||__construct(ClientInterface $client, string $url, Logger $logger)|Initializes a new sender object.|from [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender)| |bool|createTopic(string $topicId, string $registrationId)|Create a topic.|| |bool|subscribeTopic(string $topicId, array|string $recipientsTokens)|Add subscription to a topic.|| |bool|unsubscribeTopic(string $topicId, array|string $recipientsTokens)|Remove subscription from a topic.|| @@ -51,7 +51,7 @@ class **FCMTopic** extends [HT ### - **__construct**(ClientInterface $client, $url, Logger $logger)in [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender) + **__construct**(ClientInterface $client, string $url, Logger $logger)in [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender) [at line 37](https://github.com/code-lts/Laravel-FCM/blob/main/src/Sender/HTTPSender.php#L37) @@ -61,7 +61,7 @@ Initializes a new sender object. | | | | |---|---|---| -|ClientInterface|$client|||$url||Logger|$logger| +|ClientInterface|$client||string|$url||Logger|$logger| ### diff --git a/doc/LaravelFCM/Sender/HTTPSender.md b/doc/LaravelFCM/Sender/HTTPSender.md index 73f44dab1..d87012373 100644 --- a/doc/LaravelFCM/Sender/HTTPSender.md +++ b/doc/LaravelFCM/Sender/HTTPSender.md @@ -32,14 +32,14 @@ abstract class **HTTPSender** [View source](https://github.com/code-lts/Laravel- | | | | | |---|---|---|---| -||__construct(ClientInterface $client, $url, Logger $logger)|Initializes a new sender object.|| +||__construct(ClientInterface $client, string $url, Logger $logger)|Initializes a new sender object.|| ### Details ### - **__construct**(ClientInterface $client, $url, Logger $logger) + **__construct**(ClientInterface $client, string $url, Logger $logger) [at line 37](https://github.com/code-lts/Laravel-FCM/blob/main/src/Sender/HTTPSender.php#L37) @@ -49,5 +49,5 @@ Initializes a new sender object. | | | | |---|---|---| -|ClientInterface|$client|||$url||Logger|$logger| +|ClientInterface|$client||string|$url||Logger|$logger| _Generated by [Doctum, a API Documentation generator and fork of Sami](https://github.com/code-lts/doctum)._ \ No newline at end of file diff --git a/doc/LaravelFCM/Validator/FCMValidator.md b/doc/LaravelFCM/Validator/FCMValidator.md index 35d5225bc..240d66eec 100644 --- a/doc/LaravelFCM/Validator/FCMValidator.md +++ b/doc/LaravelFCM/Validator/FCMValidator.md @@ -32,7 +32,7 @@ class **FCMValidator** extends [__construct(ClientInterface $client, $url, Logger $logger)|Initializes a new sender object.|from [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender)| +||__construct(ClientInterface $client, string $url, Logger $logger)|Initializes a new sender object.|from [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender)| |bool|validateToken(string $token)|No description|| |bool|isValidResponse(ResponseInterface $response)|No description|| @@ -41,7 +41,7 @@ class **FCMValidator** extends [ ### - **__construct**(ClientInterface $client, $url, Logger $logger)in [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender) + **__construct**(ClientInterface $client, string $url, Logger $logger)in [../../LaravelFCM/Sender/HTTPSender.md#method___construct](HTTPSender) [at line 37](https://github.com/code-lts/Laravel-FCM/blob/main/src/Sender/HTTPSender.php#L37) @@ -51,7 +51,7 @@ Initializes a new sender object. | | | | |---|---|---| -|ClientInterface|$client|||$url||Logger|$logger| +|ClientInterface|$client||string|$url||Logger|$logger| ### diff --git a/doc/doc-index.md b/doc/doc-index.md index 741e1b836..6274033fa 100644 --- a/doc/doc-index.md +++ b/doc/doc-index.md @@ -41,6 +41,12 @@ A +- $[LaravelFCM/Message/Options.md#property_analyticsLabel](Options#analyticsLabel) — Property in class [Options](LaravelFCM/Message/Options.md) +() + +- $[LaravelFCM/Message/OptionsBuilder.md#property_analyticsLabel](OptionsBuilder#analyticsLabel) — Property in class [OptionsBuilder](LaravelFCM/Message/OptionsBuilder.md) +() + - [LaravelFCM/Message/PayloadDataBuilder.md#method_addData](PayloadDataBuilder::addData)() — Method in class [PayloadDataBuilder](LaravelFCM/Message/PayloadDataBuilder.md) (add data to existing data.) @@ -236,6 +242,9 @@ you should test if it's necessary to resent it.)F - [LaravelFCM/FCMManager.md#method_getDefaultDriver](FCMManager::getDefaultDriver)() — Method in class [FCMManager](LaravelFCM/FCMManager.md) () +- [LaravelFCM/FCMManager.md#method_getContainer](FCMManager::getContainer)() — Method in class [FCMManager](LaravelFCM/FCMManager.md) +(Get the app container) + - [LaravelFCM/Facades/FCM.md#method_getFacadeAccessor](FCM::getFacadeAccessor)() — Method in class [FCM](LaravelFCM/Facades/FCM.md) () @@ -254,6 +263,9 @@ you should test if it's necessary to resent it.)F - [LaravelFCM/Message/OptionsBuilder.md#method_getPriority](OptionsBuilder::getPriority)() — Method in class [OptionsBuilder](LaravelFCM/Message/OptionsBuilder.md) (Get the priority.) +- [LaravelFCM/Message/OptionsBuilder.md#method_getFcmOptionsAnalyticsLabel](OptionsBuilder::getFcmOptionsAnalyticsLabel)() — Method in class [OptionsBuilder](LaravelFCM/Message/OptionsBuilder.md) +(Get the Analytics label) + - [LaravelFCM/Message/OptionsBuilder.md#method_getTimeToLive](OptionsBuilder::getTimeToLive)() — Method in class [OptionsBuilder](LaravelFCM/Message/OptionsBuilder.md) (get time to live.) @@ -612,6 +624,9 @@ By default, messages are sent with normal priority.) - [LaravelFCM/Message/OptionsBuilder.md#method_setDryRun](OptionsBuilder::setDryRun)() — Method in class [OptionsBuilder](LaravelFCM/Message/OptionsBuilder.md) (This parameter, when set to true, allows developers to test a request without actually sending a message.) +- [LaravelFCM/Message/OptionsBuilder.md#method_setFcmOptionsAnalyticsLabel](OptionsBuilder::setFcmOptionsAnalyticsLabel)() — Method in class [OptionsBuilder](LaravelFCM/Message/OptionsBuilder.md) +(This parameter sets the Analytics label) + - [LaravelFCM/Message/PayloadDataBuilder.md#method_setData](PayloadDataBuilder::setData)() — Method in class [PayloadDataBuilder](LaravelFCM/Message/PayloadDataBuilder.md) (erase data with new data.)