Skip to content
This repository was archived by the owner on Jun 28, 2024. It is now read-only.

Commit bbf3ea3

Browse files
committed
Update generated documentation
1 parent d6ffc35 commit bbf3ea3

17 files changed

+214
-131
lines changed

doc/LaravelFCM/FCMManager.md

+16
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ class **FCMManager** extends <abbr title="Illuminate\Support\Manager">Man
2727
|---|---|---|---|
2828
||<a name="#method_getDefaultDriver"></a>getDefaultDriver()|No description||
2929
||<a name="#method_createHttpDriver"></a>createHttpDriver()|No description||
30+
|<abbr title="Illuminate\Contracts\Container\Container">Container</abbr>|<a name="#method_getContainer"></a>getContainer()|Get the app container||
3031

3132

3233
### Details
@@ -46,4 +47,19 @@ protected **createHttpDriver**()
4647
[at line 15](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMManager.php#L15)
4748

4849

50+
<a name id="method_getContainer"></a>
51+
52+
###
53+
<abbr title="Illuminate\Contracts\Container\Container">Container</abbr> **getContainer**()
54+
55+
[at line 27](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMManager.php#L27)
56+
57+
Get the app container
58+
59+
#### Return Value
60+
61+
| | |
62+
|---|---|
63+
|<abbr title="Illuminate\Contracts\Container\Container">Container</abbr>|
64+
4965
_Generated by [Doctum, a API Documentation generator and fork of Sami](https://github.com/code-lts/doctum)._

doc/LaravelFCM/Message/Options.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ class **Options** implements
3535
|<a name="property_restrictedPackageName"></a>protected null|string|$restrictedPackageName|||
3636
|<a name="property_isDryRun"></a>protected bool|$isDryRun|||
3737
|<a name="property_directBootOk"></a>protected bool|$directBootOk|||
38+
|<a name="property_analyticsLabel"></a>protected string|null|$analyticsLabel|||
3839
### Methods
3940

4041
| | | | |
@@ -49,7 +50,7 @@ class **Options** implements
4950
###
5051
**__construct**([<abbr title="LaravelFCM\Message\OptionsBuilder">OptionsBuilder</abbr>](../../LaravelFCM/Message/OptionsBuilder.md) $builder)
5152

52-
[at line 77](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Options.php#L77)
53+
[at line 84](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Options.php#L84)
5354

5455
Options constructor.
5556

@@ -63,7 +64,7 @@ Options constructor.
6364
###
6465
array **toArray**()
6566

66-
[at line 95](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Options.php#L95)
67+
[at line 103](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Options.php#L103)
6768

6869
Transform Option to array.
6970

doc/LaravelFCM/Message/OptionsBuilder.md

+82-31
Large diffs are not rendered by default.

doc/LaravelFCM/Message/OptionsPriorities.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ class **OptionsPriorities** [View source](https://github.com/code-lts/Laravel-FC
4242
###
4343
static array **getPriorities**()
4444

45-
[at line 347](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L347)
45+
[at line 382](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L382)
4646

4747

4848

@@ -64,7 +64,7 @@ static array **getPriorities**()
6464
###
6565
static bool **isValid**(string $priority)
6666

67-
[at line 363](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L363)
67+
[at line 398](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L398)
6868

6969
check if this priority is supported by fcm.
7070

doc/LaravelFCM/Message/PayloadDataBuilder.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,18 @@ Official google documentation :
3030

3131
| | | | |
3232
|---|---|---|---|
33-
|PayloadDataBuilder|<a name="#method_addData"></a>addData(array $data)|add data to existing data.||
34-
|PayloadDataBuilder|<a name="#method_setData"></a>setData(array $data)|erase data with new data.||
33+
|[<abbr title="LaravelFCM\Message\PayloadDataBuilder">PayloadDataBuilder</abbr>](../../LaravelFCM/Message/PayloadDataBuilder.md)|<a name="#method_addData"></a>addData(array $data)|add data to existing data.||
34+
|[<abbr title="LaravelFCM\Message\PayloadDataBuilder">PayloadDataBuilder</abbr>](../../LaravelFCM/Message/PayloadDataBuilder.md)|<a name="#method_setData"></a>setData(array $data)|erase data with new data.||
3535
||<a name="#method_removeAllData"></a>removeAllData()|Remove all data.||
3636
|array|<a name="#method_getData"></a>getData()|return data.||
37-
|PayloadData|<a name="#method_build"></a>build()|generate a PayloadData.||
37+
|[<abbr title="LaravelFCM\Message\PayloadData">PayloadData</abbr>](../../LaravelFCM/Message/PayloadData.md)|<a name="#method_build"></a>build()|generate a PayloadData.||
3838

3939

4040
### Details
4141
<a name id="method_addData"></a>
4242

4343
###
44-
PayloadDataBuilder **addData**(array $data)
44+
[<abbr title="LaravelFCM\Message\PayloadDataBuilder">PayloadDataBuilder</abbr>](../../LaravelFCM/Message/PayloadDataBuilder.md) **addData**(array $data)
4545

4646
[at line 26](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadDataBuilder.php#L26)
4747

@@ -57,12 +57,12 @@ add data to existing data.
5757

5858
| | |
5959
|---|---|
60-
|PayloadDataBuilder|
60+
|[<abbr title="LaravelFCM\Message\PayloadDataBuilder">PayloadDataBuilder</abbr>](../../LaravelFCM/Message/PayloadDataBuilder.md)|
6161

6262
<a name id="method_setData"></a>
6363

6464
###
65-
PayloadDataBuilder **setData**(array $data)
65+
[<abbr title="LaravelFCM\Message\PayloadDataBuilder">PayloadDataBuilder</abbr>](../../LaravelFCM/Message/PayloadDataBuilder.md) **setData**(array $data)
6666

6767
[at line 42](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadDataBuilder.php#L42)
6868

@@ -78,7 +78,7 @@ erase data with new data.
7878

7979
| | |
8080
|---|---|
81-
|PayloadDataBuilder|
81+
|[<abbr title="LaravelFCM\Message\PayloadDataBuilder">PayloadDataBuilder</abbr>](../../LaravelFCM/Message/PayloadDataBuilder.md)|
8282

8383
<a name id="method_removeAllData"></a>
8484

@@ -106,7 +106,7 @@ return data.
106106
<a name id="method_build"></a>
107107

108108
###
109-
PayloadData **build**()
109+
[<abbr title="LaravelFCM\Message\PayloadData">PayloadData</abbr>](../../LaravelFCM/Message/PayloadData.md) **build**()
110110

111111
[at line 72](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadDataBuilder.php#L72)
112112

@@ -116,6 +116,6 @@ generate a PayloadData.
116116

117117
| | |
118118
|---|---|
119-
|PayloadData|new PayloadData instance
119+
|[<abbr title="LaravelFCM\Message\PayloadData">PayloadData</abbr>](../../LaravelFCM/Message/PayloadData.md)|new PayloadData instance
120120

121121
_Generated by [Doctum, a API Documentation generator and fork of Sami](https://github.com/code-lts/doctum)._

0 commit comments

Comments
 (0)