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

Commit d3d6e88

Browse files
williamdeswilliamdes
committed
Update rendered documentation
1 parent b8df5e2 commit d3d6e88

36 files changed

+202
-202
lines changed

‎doc/LaravelFCM/FCMManager.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
> [LaravelFCM](../LaravelFCM.md)` / `(FCMManager)
1515
## FCMManager
1616

17-
class **FCMManager** extends <abbr title="Illuminate\Support\Manager">Manager</abbr>[View source](https://github.com/code-lts/Laravel-FCM/blob/main/FCMManager.php)
17+
class **FCMManager** extends <abbr title="Illuminate\Support\Manager">Manager</abbr> [View source](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMManager.php)
1818

1919

2020

@@ -35,15 +35,15 @@ class **FCMManager** extends <abbr title="Illuminate\Support\Manager">Man
3535
###
3636
**getDefaultDriver**()
3737

38-
[at line 10](https://github.com/code-lts/Laravel-FCM/blob/main/FCMManager.php#L10)
38+
[at line 10](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMManager.php#L10)
3939

4040

4141
<a name id="method_createHttpDriver"></a>
4242

4343
###
4444
protected **createHttpDriver**()
4545

46-
[at line 15](https://github.com/code-lts/Laravel-FCM/blob/main/FCMManager.php#L15)
46+
[at line 15](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMManager.php#L15)
4747

4848

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

‎doc/LaravelFCM/FCMServiceProvider.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
> [LaravelFCM](../LaravelFCM.md)` / `(FCMServiceProvider)
1515
## FCMServiceProvider
1616

17-
class **FCMServiceProvider** extends <abbr title="Illuminate\Support\ServiceProvider">ServiceProvider</abbr>[View source](https://github.com/code-lts/Laravel-FCM/blob/main/FCMServiceProvider.php)
17+
class **FCMServiceProvider** extends <abbr title="Illuminate\Support\ServiceProvider">ServiceProvider</abbr> [View source](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMServiceProvider.php)
1818

1919

2020

@@ -41,23 +41,23 @@ class **FCMServiceProvider** extends <abbr title="Illuminate\Support\Serv
4141
###
4242
**boot**()
4343

44-
[at line 19](https://github.com/code-lts/Laravel-FCM/blob/main/FCMServiceProvider.php#L19)
44+
[at line 19](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMServiceProvider.php#L19)
4545

4646

4747
<a name id="method_register"></a>
4848

4949
###
5050
**register**()
5151

52-
[at line 30](https://github.com/code-lts/Laravel-FCM/blob/main/FCMServiceProvider.php#L30)
52+
[at line 30](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMServiceProvider.php#L30)
5353

5454

5555
<a name id="method_provides"></a>
5656

5757
###
5858
**provides**()
5959

60-
[at line 84](https://github.com/code-lts/Laravel-FCM/blob/main/FCMServiceProvider.php#L84)
60+
[at line 84](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMServiceProvider.php#L84)
6161

6262

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

‎doc/LaravelFCM/Facades/FCM.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
> [LaravelFCM](../../LaravelFCM.md)` / `[Facades](../../LaravelFCM/Facades.md)` / `(FCM)
1515
## FCM
1616

17-
class **FCM** extends <abbr title="Illuminate\Support\Facades\Facade">Facade</abbr>[View source](https://github.com/code-lts/Laravel-FCM/blob/main/Facades/FCM.php)
17+
class **FCM** extends <abbr title="Illuminate\Support\Facades\Facade">Facade</abbr> [View source](https://github.com/code-lts/Laravel-FCM/blob/main/src/Facades/FCM.php)
1818

1919

2020

@@ -34,7 +34,7 @@ class **FCM** extends <abbr title="Illuminate\Support\Facades\Facade">Fac
3434
###
3535
staticprotected **getFacadeAccessor**()
3636

37-
[at line 12](https://github.com/code-lts/Laravel-FCM/blob/main/Facades/FCM.php#L12)
37+
[at line 12](https://github.com/code-lts/Laravel-FCM/blob/main/src/Facades/FCM.php#L12)
3838

3939

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

‎doc/LaravelFCM/Facades/FCMGroup.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
> [LaravelFCM](../../LaravelFCM.md)` / `[Facades](../../LaravelFCM/Facades.md)` / `(FCMGroup)
1515
## FCMGroup
1616

17-
class **FCMGroup** extends <abbr title="Illuminate\Support\Facades\Facade">Facade</abbr>[View source](https://github.com/code-lts/Laravel-FCM/blob/main/Facades/FCMGroup.php)
17+
class **FCMGroup** extends <abbr title="Illuminate\Support\Facades\Facade">Facade</abbr> [View source](https://github.com/code-lts/Laravel-FCM/blob/main/src/Facades/FCMGroup.php)
1818

1919

2020

@@ -34,7 +34,7 @@ class **FCMGroup** extends <abbr title="Illuminate\Support\Facades\Facade
3434
###
3535
staticprotected **getFacadeAccessor**()
3636

37-
[at line 9](https://github.com/code-lts/Laravel-FCM/blob/main/Facades/FCMGroup.php#L9)
37+
[at line 9](https://github.com/code-lts/Laravel-FCM/blob/main/src/Facades/FCMGroup.php#L9)
3838

3939

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

‎doc/LaravelFCM/Facades/FCMTopic.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
> [LaravelFCM](../../LaravelFCM.md)` / `[Facades](../../LaravelFCM/Facades.md)` / `(FCMTopic)
1515
## FCMTopic
1616

17-
class **FCMTopic** extends <abbr title="Illuminate\Support\Facades\Facade">Facade</abbr>[View source](https://github.com/code-lts/Laravel-FCM/blob/main/Facades/FCMTopic.php)
17+
class **FCMTopic** extends <abbr title="Illuminate\Support\Facades\Facade">Facade</abbr> [View source](https://github.com/code-lts/Laravel-FCM/blob/main/src/Facades/FCMTopic.php)
1818

1919

2020

@@ -34,7 +34,7 @@ class **FCMTopic** extends <abbr title="Illuminate\Support\Facades\Facade
3434
###
3535
staticprotected **getFacadeAccessor**()
3636

37-
[at line 13](https://github.com/code-lts/Laravel-FCM/blob/main/Facades/FCMTopic.php#L13)
37+
[at line 13](https://github.com/code-lts/Laravel-FCM/blob/main/src/Facades/FCMTopic.php#L13)
3838

3939

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

‎doc/LaravelFCM/Facades/FCMValidator.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
> [LaravelFCM](../../LaravelFCM.md)` / `[Facades](../../LaravelFCM/Facades.md)` / `(FCMValidator)
1515
## FCMValidator
1616

17-
class **FCMValidator** extends <abbr title="Illuminate\Support\Facades\Facade">Facade</abbr>[View source](https://github.com/code-lts/Laravel-FCM/blob/main/Facades/FCMValidator.php)
17+
class **FCMValidator** extends <abbr title="Illuminate\Support\Facades\Facade">Facade</abbr> [View source](https://github.com/code-lts/Laravel-FCM/blob/main/src/Facades/FCMValidator.php)
1818

1919

2020

@@ -34,7 +34,7 @@ class **FCMValidator** extends <abbr title="Illuminate\Support\Facades\Fa
3434
###
3535
staticprotected **getFacadeAccessor**()
3636

37-
[at line 11](https://github.com/code-lts/Laravel-FCM/blob/main/Facades/FCMValidator.php#L11)
37+
[at line 11](https://github.com/code-lts/Laravel-FCM/blob/main/src/Facades/FCMValidator.php#L11)
3838

3939

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

‎doc/LaravelFCM/Message/Exceptions/InvalidOptionsException.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
> [LaravelFCM](../../../LaravelFCM.md)` / `[Message](../../../LaravelFCM/Message.md)` / `[Exceptions](../../../LaravelFCM/Message/Exceptions.md)` / `(InvalidOptionsException)
1515
## InvalidOptionsException
1616

17-
class **InvalidOptionsException** extends [Exception](https://www.php.net/Exception)[View source](https://github.com/code-lts/Laravel-FCM/blob/main/Message/Exceptions/InvalidOptionsException.php)
17+
class **InvalidOptionsException** extends [Exception](https://www.php.net/Exception) [View source](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Exceptions/InvalidOptionsException.php)
1818

1919

2020

‎doc/LaravelFCM/Message/Exceptions/NoTopicProvidedException.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
> [LaravelFCM](../../../LaravelFCM.md)` / `[Message](../../../LaravelFCM/Message.md)` / `[Exceptions](../../../LaravelFCM/Message/Exceptions.md)` / `(NoTopicProvidedException)
1515
## NoTopicProvidedException
1616

17-
class **NoTopicProvidedException** extends [Exception](https://www.php.net/Exception)[View source](https://github.com/code-lts/Laravel-FCM/blob/main/Message/Exceptions/NoTopicProvidedException.php)
17+
class **NoTopicProvidedException** extends [Exception](https://www.php.net/Exception) [View source](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Exceptions/NoTopicProvidedException.php)
1818

1919

2020

‎doc/LaravelFCM/Message/Options.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
## Options
1616

1717
class **Options** implements
18-
<abbr title="Illuminate\Contracts\Support\Arrayable">Arrayable</abbr>[View source](https://github.com/code-lts/Laravel-FCM/blob/main/Message/Options.php)
18+
<abbr title="Illuminate\Contracts\Support\Arrayable">Arrayable</abbr> [View source](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Options.php)
1919

2020

2121

@@ -49,7 +49,7 @@ class **Options** implements
4949
###
5050
**__construct**([<abbr title="LaravelFCM\Message\OptionsBuilder">OptionsBuilder</abbr>](../../LaravelFCM/Message/OptionsBuilder.md) $builder)
5151

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

5454
Options constructor.
5555

@@ -63,7 +63,7 @@ Options constructor.
6363
###
6464
array **toArray**()
6565

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

6868
Transform Option to array.
6969

‎doc/LaravelFCM/Message/OptionsBuilder.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
> [LaravelFCM](../../LaravelFCM.md)` / `[Message](../../LaravelFCM/Message.md)` / `(OptionsBuilder)
1515
## OptionsBuilder
1616

17-
class **OptionsBuilder**[View source](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php)
17+
class **OptionsBuilder** [View source](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php)
1818

1919

2020

@@ -65,7 +65,7 @@ Builder for creation of options used by FCM.
6565
###
6666
[<abbr title="LaravelFCM\Message\OptionsBuilder">OptionsBuilder</abbr>](../../LaravelFCM/Message/OptionsBuilder.md) **setCollapseKey**(string $collapseKey)
6767

68-
[at line 85](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L85)
68+
[at line 85](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L85)
6969

7070
This parameter identifies a group of messages
7171
A maximum of 4 different collapse keys is allowed at any given time.
@@ -87,7 +87,7 @@ A maximum of 4 different collapse keys is allowed at any given time.
8787
###
8888
[<abbr title="LaravelFCM\Message\OptionsBuilder">OptionsBuilder</abbr>](../../LaravelFCM/Message/OptionsBuilder.md) **setDirectBootOk**(bool $directBootOk)
8989

90-
[at line 102](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L102)
90+
[at line 102](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L102)
9191

9292
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).
9393

@@ -114,7 +114,7 @@ If set to true, messages will be allowed to be delivered to the app while the de
114114
###
115115
[<abbr title="LaravelFCM\Message\OptionsBuilder">OptionsBuilder</abbr>](../../LaravelFCM/Message/OptionsBuilder.md) **setPriority**(string $priority)
116116

117-
[at line 120](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L120)
117+
[at line 120](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L120)
118118

119119
Sets the priority of the message. Valid values are "normal" and "high."
120120
By default, messages are sent with normal priority.
@@ -144,7 +144,7 @@ By default, messages are sent with normal priority.
144144
###
145145
[<abbr title="LaravelFCM\Message\OptionsBuilder">OptionsBuilder</abbr>](../../LaravelFCM/Message/OptionsBuilder.md) **setContentAvailable**(bool $contentAvailable)
146146

147-
[at line 142](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L142)
147+
[at line 142](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L142)
148148

149149
support only Android and Ios. An inactive client app is awoken.
150150
On iOS, use this field to represent content-available in the APNS payload.
@@ -168,7 +168,7 @@ On Chrome, currently not supported.
168168
###
169169
OptionsBuilder **setMutableContent**(bool $isMutableContent)
170170

171-
[at line 158](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L158)
171+
[at line 158](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L158)
172172

173173
support iOS 10+ When a notification is sent and this is set to true,
174174
the content of the notification can be modified before it is displayed.
@@ -190,7 +190,7 @@ the content of the notification can be modified before it is displayed.
190190
###
191191
[<abbr title="LaravelFCM\Message\OptionsBuilder">OptionsBuilder</abbr>](../../LaravelFCM/Message/OptionsBuilder.md) **setDelayWhileIdle**(bool $delayWhileIdle)
192192

193-
[at line 172](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L172)
193+
[at line 172](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L172)
194194

195195
When this parameter is set to true, it indicates that the message should not be sent until the device becomes active.
196196

@@ -211,7 +211,7 @@ When this parameter is set to true, it indicates that the message should not be
211211
###
212212
[<abbr title="LaravelFCM\Message\OptionsBuilder">OptionsBuilder</abbr>](../../LaravelFCM/Message/OptionsBuilder.md) **setTimeToLive**(int $timeToLive)
213213

214-
[at line 188](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L188)
214+
[at line 188](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L188)
215215

216216
This parameter specifies how long the message should be kept in FCM storage if the device is offline.
217217

@@ -239,7 +239,7 @@ This parameter specifies how long the message should be kept in FCM storage if t
239239
###
240240
[<abbr title="LaravelFCM\Message\OptionsBuilder">OptionsBuilder</abbr>](../../LaravelFCM/Message/OptionsBuilder.md) **setRestrictedPackageName**(string $restrictedPackageName)
241241

242-
[at line 206](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L206)
242+
[at line 206](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L206)
243243

244244
This parameter specifies the package name of the application where the registration tokens must match in order to receive the message. (Android only)
245245

@@ -260,7 +260,7 @@ This parameter specifies the package name of the application where the registrat
260260
###
261261
[<abbr title="LaravelFCM\Message\OptionsBuilder">OptionsBuilder</abbr>](../../LaravelFCM/Message/OptionsBuilder.md) **setDryRun**(bool $isDryRun)**deprecated**
262262

263-
[at line 222](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L222)| | |
263+
[at line 222](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L222)| | |
264264
|---|---|
265265
**deprecated**
266266
||v1 (https://stackoverflow.com/a/53885050/5155484)|
@@ -285,7 +285,7 @@ This parameter, when set to true, allows developers to test a request without ac
285285
###
286286
null|string **getCollapseKey**()
287287

288-
[at line 234](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L234)
288+
[at line 234](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L234)
289289

290290
Get the collapseKey.
291291

@@ -300,7 +300,7 @@ Get the collapseKey.
300300
###
301301
null|string **getPriority**()
302302

303-
[at line 244](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L244)
303+
[at line 244](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L244)
304304

305305
Get the priority.
306306

@@ -315,7 +315,7 @@ Get the priority.
315315
###
316316
bool **isContentAvailable**()
317317

318-
[at line 254](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L254)
318+
[at line 254](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L254)
319319

320320
is content available.
321321

@@ -330,7 +330,7 @@ is content available.
330330
###
331331
bool **isMutableContent**()
332332

333-
[at line 264](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L264)
333+
[at line 264](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L264)
334334

335335
is mutable content
336336

@@ -345,7 +345,7 @@ is mutable content
345345
###
346346
bool **isDelayWhileIdle**()
347347

348-
[at line 274](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L274)
348+
[at line 274](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L274)
349349

350350
is delay white idle.
351351

@@ -360,7 +360,7 @@ is delay white idle.
360360
###
361361
null|int **getTimeToLive**()
362362

363-
[at line 284](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L284)
363+
[at line 284](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L284)
364364

365365
get time to live.
366366

@@ -375,7 +375,7 @@ get time to live.
375375
###
376376
null|string **getRestrictedPackageName**()
377377

378-
[at line 294](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L294)
378+
[at line 294](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L294)
379379

380380
get restricted package name.
381381

@@ -390,7 +390,7 @@ get restricted package name.
390390
###
391391
bool **isDryRun**()
392392

393-
[at line 304](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L304)
393+
[at line 304](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L304)
394394

395395
is dry run.
396396

@@ -405,7 +405,7 @@ is dry run.
405405
###
406406
bool **isDirectBootOk**()
407407

408-
[at line 314](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L314)
408+
[at line 314](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L314)
409409

410410
is direct boot ok
411411

@@ -420,7 +420,7 @@ is direct boot ok
420420
###
421421
Options **build**()
422422

423-
[at line 324](https://github.com/code-lts/Laravel-FCM/blob/main/Message/OptionsBuilder.php#L324)
423+
[at line 324](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/OptionsBuilder.php#L324)
424424

425425
build an instance of Options.
426426

0 commit comments

Comments
 (0)