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

Commit

Permalink
Update generated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
williamdes committed Apr 3, 2021
1 parent d6ffc35 commit bbf3ea3
Show file tree
Hide file tree
Showing 17 changed files with 214 additions and 131 deletions.
16 changes: 16 additions & 0 deletions doc/LaravelFCM/FCMManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ class **FCMManager** extends <abbr title="Illuminate\Support\Manager">Man
|---|---|---|---|
||<a name="#method_getDefaultDriver"></a>getDefaultDriver()|No description||
||<a name="#method_createHttpDriver"></a>createHttpDriver()|No description||
|<abbr title="Illuminate\Contracts\Container\Container">Container</abbr>|<a name="#method_getContainer"></a>getContainer()|Get the app container||


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


<a name id="method_getContainer"></a>

###
<abbr title="Illuminate\Contracts\Container\Container">Container</abbr> **getContainer**()

[at line 27](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMManager.php#L27)

Get the app container

#### Return Value

| | |
|---|---|
|<abbr title="Illuminate\Contracts\Container\Container">Container</abbr>|

_Generated by [Doctum, a API Documentation generator and fork of Sami](https://github.com/code-lts/doctum)._
5 changes: 3 additions & 2 deletions doc/LaravelFCM/Message/Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ class **Options** implements
|<a name="property_restrictedPackageName"></a>protected null|string|$restrictedPackageName|||
|<a name="property_isDryRun"></a>protected bool|$isDryRun|||
|<a name="property_directBootOk"></a>protected bool|$directBootOk|||
|<a name="property_analyticsLabel"></a>protected string|null|$analyticsLabel|||
### Methods

| | | | |
Expand All @@ -49,7 +50,7 @@ class **Options** implements
###
**__construct**([<abbr title="LaravelFCM\Message\OptionsBuilder">OptionsBuilder</abbr>](../../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.

Expand All @@ -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.

Expand Down
113 changes: 82 additions & 31 deletions doc/LaravelFCM/Message/OptionsBuilder.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions doc/LaravelFCM/Message/OptionsPriorities.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)



Expand All @@ -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.

Expand Down
18 changes: 9 additions & 9 deletions doc/LaravelFCM/Message/PayloadDataBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ Official google documentation :

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


### Details
<a name id="method_addData"></a>

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

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

Expand All @@ -57,12 +57,12 @@ add data to existing data.

| | |
|---|---|
|PayloadDataBuilder|
|[<abbr title="LaravelFCM\Message\PayloadDataBuilder">PayloadDataBuilder</abbr>](../../LaravelFCM/Message/PayloadDataBuilder.md)|

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

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

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

Expand All @@ -78,7 +78,7 @@ erase data with new data.

| | |
|---|---|
|PayloadDataBuilder|
|[<abbr title="LaravelFCM\Message\PayloadDataBuilder">PayloadDataBuilder</abbr>](../../LaravelFCM/Message/PayloadDataBuilder.md)|

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

Expand Down Expand Up @@ -106,7 +106,7 @@ return data.
<a name id="method_build"></a>

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

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

Expand All @@ -116,6 +116,6 @@ generate a PayloadData.

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

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

0 comments on commit bbf3ea3

Please sign in to comment.