From f28d370865091edc463c0eef81e077b9dafd5849 Mon Sep 17 00:00:00 2001 From: SuperSonic Date: Wed, 28 Jul 2021 17:40:52 +0800 Subject: [PATCH] Update documentation --- .gitignore | 7 +- docs/classes/LINEAPI.html | 769 ++++++++++++----------- docs/classes/LINEMSG-FlexContainer.html | 139 +++- docs/classes/LINEMSG-Imagemap.html | 134 +++- docs/classes/LINEMSG-QuickReply.html | 184 ++++-- docs/classes/LINEMSG-Template.html | 190 ++++-- docs/classes/LINEMSG.html | 281 +++++---- docs/css/base.css | 70 ++- docs/css/normalize.css | 0 docs/css/template.css | 19 + docs/files/api.html | 34 +- docs/files/examples-echo-bot.html | 15 +- docs/graphs/classes.html | 12 +- docs/index.html | 39 +- docs/indices/files.html | 15 +- docs/js/search.js | 0 docs/js/searchIndex.js | 2 +- docs/namespaces/default.html | 29 +- docs/packages/Application.html | 203 ++++++ docs/packages/Default.html | 0 docs/packages/default.html | 15 +- docs/packages/line-bot-sdk-php-tiny.html | 0 docs/packages/line-bot-sdk-php.html | 0 docs/packages/line-bot-sdk.html | 0 docs/packages/line-bot.html | 0 docs/packages/line.html | 0 docs/reports/deprecated.html | 13 +- docs/reports/errors.html | 13 +- docs/reports/markers.html | 418 +++++++++++- 29 files changed, 1853 insertions(+), 748 deletions(-) mode change 100644 => 100755 docs/classes/LINEAPI.html mode change 100644 => 100755 docs/classes/LINEMSG-FlexContainer.html mode change 100644 => 100755 docs/classes/LINEMSG-Imagemap.html mode change 100644 => 100755 docs/classes/LINEMSG-QuickReply.html mode change 100644 => 100755 docs/classes/LINEMSG-Template.html mode change 100644 => 100755 docs/classes/LINEMSG.html mode change 100644 => 100755 docs/css/base.css mode change 100644 => 100755 docs/css/normalize.css mode change 100644 => 100755 docs/css/template.css mode change 100644 => 100755 docs/files/api.html mode change 100644 => 100755 docs/files/examples-echo-bot.html mode change 100644 => 100755 docs/graphs/classes.html mode change 100644 => 100755 docs/index.html mode change 100644 => 100755 docs/indices/files.html mode change 100644 => 100755 docs/js/search.js mode change 100644 => 100755 docs/js/searchIndex.js mode change 100644 => 100755 docs/namespaces/default.html create mode 100644 docs/packages/Application.html mode change 100644 => 100755 docs/packages/Default.html mode change 100644 => 100755 docs/packages/default.html mode change 100644 => 100755 docs/packages/line-bot-sdk-php-tiny.html mode change 100644 => 100755 docs/packages/line-bot-sdk-php.html mode change 100644 => 100755 docs/packages/line-bot-sdk.html mode change 100644 => 100755 docs/packages/line-bot.html mode change 100644 => 100755 docs/packages/line.html mode change 100644 => 100755 docs/reports/deprecated.html mode change 100644 => 100755 docs/reports/errors.html mode change 100644 => 100755 docs/reports/markers.html diff --git a/.gitignore b/.gitignore index 24a9c8b..7b44f02 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,8 @@ -/.idea/ composer.lock composer.phar -/tests/Private + +.idea/ *.iml + vendor/ -/build +build diff --git a/docs/classes/LINEAPI.html b/docs/classes/LINEAPI.html old mode 100644 new mode 100755 index 986edb9..84c4cd1 --- a/docs/classes/LINEAPI.html +++ b/docs/classes/LINEAPI.html @@ -15,6 +15,7 @@ + @@ -51,13 +52,12 @@

lin Menu + +

LINEAPI (Messaging API)

@@ -167,14 +174,14 @@

$channelAccessToken -  : string +  : string|null
The value is set for authorizing while the API connecting LINE API Platform.
$channelSecret -  : string +  : string|null
The value is set for verifying signatures that whether the requests were sent from the LINE API Platform.
@@ -183,7 +190,7 @@

 : mixed -
+
LINEAPI constructor.
broadcast() @@ -513,7 +520,8 @@

api.php : 116 - + +

The host is used for uploading/downloading objects from LINE API Platform.

@@ -525,7 +533,9 @@

-
+ +

API_HOST

+
@@ -540,7 +550,8 @@

api.php : 109 - + +

The host is used for connecting the primary service of LINE API Platform.

@@ -552,7 +563,9 @@

-
+ +

API_HOST

+
@@ -567,7 +580,8 @@

api.php : 143 - + +

HTTP Delete Method

@@ -584,6 +598,9 @@

+

HTTP_METHOD_DELETE

+
+ @@ -597,7 +614,8 @@

api.php : 125 - + +

HTTP Get Method

@@ -605,7 +623,7 @@

public int HTTP_METHOD_GET - = "" + = 0 @@ -614,6 +632,9 @@

+

HTTP_METHOD_GET

+
+ @@ -627,7 +648,8 @@

api.php : 134 - + +

HTTP Post Method

@@ -644,6 +666,9 @@

+

HTTP_METHOD_POST

+
+ @@ -672,7 +697,8 @@

api.php : 81 - + +

If read the response as array while decoding JSON in `requestFactory`.

@@ -682,7 +708,9 @@

$responseDecodeAsArray = alse -
+ +

The default is exporting as Object, set value to true that it will use Array.

+
@@ -704,13 +732,14 @@

api.php : 92 - + +

The value is set for authorizing while the API connecting LINE API Platform.

private - string + string|null $channelAccessToken @@ -718,6 +747,7 @@

+

Tags @@ -757,18 +787,19 @@

api.php : 102 - + +

The value is set for verifying signatures that whether the requests were sent from the LINE API Platform.

private - string + string|null $channelSecret -
- + +

Tags @@ -812,27 +843,33 @@

+ 155 + + + +

LINEAPI constructor.

- public - __construct(mixed $channelAccessToken, mixed $channelSecret) : mixed + __construct( $channelAccessToken,  $channelSecret) : mixed + +

This is the constructor of API, to initialize your certificates into it. +If you need to use issueChannelAccessToken, you can set both of them as null, +issueChannelAccessToken will setup the values automatically.

+
-

Parameters
$channelAccessToken - : mixed + :
$channelSecret - : mixed + :
@@ -844,8 +881,7 @@
Parameters
Return values
mixed — -
- +
+ 604 + +

Send broadcast message.

@@ -870,8 +907,7 @@

public broadcast(array<string|int, mixed> $message[, bool $notificationDisabled = false ]) : object -
- +

Parameters
@@ -879,8 +915,7 @@
Parameters
: array<string|int, mixed>
-
- +
$notificationDisabled @@ -911,8 +946,7 @@
Return values
object — -
- +
api.php : - 705 - + 716 + +

Confirming that an audience is ready to accept messages.

@@ -937,8 +972,7 @@

public confirmingAudienceGroupStatus(string $audienceGroupId) : object -
- +

Parameters
@@ -946,8 +980,7 @@
Parameters
: string
-
- +
@@ -969,8 +1002,7 @@
Return values
object — -
- +
+ 800 + +

Create rich menu.

@@ -995,8 +1028,7 @@

public createRichMenu(string $content) : object -
- +

Parameters
@@ -1004,8 +1036,7 @@
Parameters
: string
-
- +
@@ -1027,8 +1058,7 @@
Return values
object — -
- +
+ 817 + +

Delete rich menu.

@@ -1053,8 +1084,7 @@

public deleteRichMenu(string $richMenuId) : object -
- +

Parameters
@@ -1062,8 +1092,7 @@
Parameters
: string
-
- +
@@ -1085,8 +1114,7 @@
Return values
object — -
- +
+ 750 + +

Save file of the message from the function `getMessageObject`.

@@ -1111,8 +1140,7 @@

public downloadMessageObject(string $messageId[, string $path = "./" ]) : bool -
- +

Parameters
@@ -1120,8 +1148,7 @@
Parameters
: string
-
- +
$path @@ -1157,8 +1184,9 @@

+ 922 + +

Save image of the rich menu from the function `getRichMenuImage`.

@@ -1166,8 +1194,7 @@

public downloadRichMenuImage(string $richMenuId[, string $path = "./" ]) : bool -
- +

Parameters
@@ -1175,8 +1202,7 @@
Parameters
: string
-
- +
$path @@ -1212,8 +1238,9 @@

+ 644 + +

Get number of messages sent this month.

@@ -1221,8 +1248,7 @@

public getAllMessagesSentCount() : object -
- +

@@ -1242,8 +1268,7 @@
Return values
object — -
- +
api.php : - 689 - + 700 + +

Get number of sent broadcast messages.

@@ -1268,8 +1294,7 @@

public getBroadcastMessagesSentCount() : object -
- +

@@ -1289,8 +1314,7 @@
Return values
object — -
- +
+ 265 + +

Get number of followers.

@@ -1315,8 +1340,7 @@

public getFollowersCount(string $date) : object -
- +

Parameters
@@ -1324,8 +1348,7 @@
Parameters
: string
-
- +
@@ -1347,8 +1370,7 @@
Return values
object — -
- +
+ 343 + +

Get the user ID of all users who added your LINE Official Accout as a friend.

@@ -1373,8 +1396,7 @@

public getFollowersIds([string $continuationToken = "" ]) : object -
- +

Parameters
@@ -1406,8 +1428,7 @@
Return values
object — -
- +
+ 279 + +

Get friend demographics.

@@ -1432,8 +1454,7 @@

public getFriendDemographics() : object -
- +

@@ -1453,8 +1474,7 @@
Return values
object — -
- +
+ 360 + +

Get group summary.

@@ -1479,8 +1500,7 @@

public getGroup(string $groupId) : object -
- +

Parameters
@@ -1488,8 +1508,7 @@
Parameters
: string
-
- +
@@ -1511,8 +1530,7 @@
Return values
object — -
- +
+ 376 + +

Get number of users in a group.

@@ -1537,8 +1556,7 @@

public getGroupMemberCount(string $groupId) : object -
- +

Parameters
@@ -1546,8 +1564,7 @@
Parameters
: string
-
- +
@@ -1569,8 +1586,7 @@
Return values
object — -
- +
+ 410 + +

Get group member user IDs.

@@ -1595,8 +1612,7 @@

public getGroupMemberIds(string $groupId[, string $continuationToken = "" ]) : object -
- +

Parameters
@@ -1604,8 +1620,7 @@
Parameters
: string
-
- +
$continuationToken @@ -1636,8 +1651,7 @@
Return values
object — -
- +
+ 393 + +

Get group member profile.

@@ -1662,8 +1677,7 @@

public getGroupMemberInfo(string $groupId, string $userId) : object -
- +

Parameters
@@ -1671,16 +1685,14 @@
Parameters
: string
-
- +
$userId : string
-
- +
@@ -1702,8 +1714,7 @@
Return values
object — -
- +
+ 249 + +

Get number of message deliveries.

@@ -1728,8 +1740,7 @@

public getMessageDeliveriesCount(string $date) : object -
- +

Parameters
@@ -1737,8 +1748,7 @@
Parameters
: string
-
- +
@@ -1760,8 +1770,7 @@
Return values
object — -
- +
+ 732 + +

Download content of the message. (Get the raw data only)

@@ -1786,8 +1796,7 @@

public getMessageObject(string $messageId) : string|null -
- +

Parameters
@@ -1795,8 +1804,7 @@
Parameters
: string
-
- +
@@ -1818,8 +1826,7 @@
Return values
string|null — -
- +
api.php : - 675 - + 686 + +

Get number of sent multicast messages.

@@ -1844,8 +1852,7 @@

public getMulticastMessagesSentCount() : object -
- +

@@ -1865,8 +1872,7 @@
Return values
object — -
- +
+ 327 + +

Get profile.

@@ -1891,8 +1898,7 @@

public getProfile(string $userId) : object -
- +

Parameters
@@ -1900,8 +1906,7 @@
Parameters
: string
-
- +
@@ -1923,8 +1928,7 @@
Return values
object — -
- +
+ 672 + +

Get number of sent push messages.

@@ -1949,8 +1954,7 @@

public getPushMessagesSentCount() : object -
- +

@@ -1970,8 +1974,7 @@
Return values
object — -
- +
+ 658 + +

Get number of sent reply messages.

@@ -1996,8 +2000,7 @@

public getReplyMessagesSentCount() : object -
- +

@@ -2017,8 +2020,7 @@
Return values
object — -
- +
+ 784 + +

Get rich menu.

@@ -2043,8 +2046,7 @@

public getRichMenu(string $richMenuId) : object -
- +

Parameters
@@ -2052,8 +2054,7 @@
Parameters
: string
-
- +
@@ -2075,8 +2076,7 @@
Return values
object — -
- +
+ 833 + +

Get rich menu ID of user.

@@ -2101,8 +2102,7 @@

public getRichMenuIdOfUser(string $userId) : object -
- +

Parameters
@@ -2110,8 +2110,7 @@
Parameters
: string
-
- +
@@ -2133,8 +2132,7 @@
Return values
object — -
- +
+ 904 + +

Download rich menu image. (Get the raw data only)

@@ -2159,8 +2158,7 @@

public getRichMenuImage(string $richMenuId) : string|null -
- +

Parameters
@@ -2168,8 +2166,7 @@
Parameters
: string
-
- +
@@ -2191,8 +2188,7 @@
Return values
string|null — -
- +
+ 768 + +

Get rich menu list.

@@ -2217,8 +2214,7 @@

public getRichMenuList() : object -
- +

@@ -2238,8 +2234,7 @@
Return values
object — -
- +
+ 443 + +

Get number of users in a room.

@@ -2264,8 +2260,7 @@

public getRoomMemberCount(string $roomId) : object -
- +

Parameters
@@ -2273,8 +2268,7 @@
Parameters
: string
-
- +
@@ -2296,8 +2290,7 @@
Return values
object — -
- +
+ 477 + +

Get room member profile.

@@ -2322,8 +2316,7 @@

public getRoomMemberIds(string $roomId[, string $continuationToken = "" ]) : object -
- +

Parameters
@@ -2331,8 +2324,7 @@
Parameters
: string
-
- +
$continuationToken @@ -2363,8 +2355,7 @@
Return values
object — -
- +
+ 460 + +

Get room member user IDs.

@@ -2389,8 +2381,7 @@

public getRoomMemberInfo(string $roomId, string $userId) : object -
- +

Parameters
@@ -2398,16 +2389,14 @@
Parameters
: string
-
- +
$userId : string
-
- +
@@ -2429,8 +2418,7 @@
Return values
object — -
- +
+ 630 + +

Get the target limit for additional messages.

@@ -2455,8 +2444,7 @@

public getSendMessagesQuota() : object -
- +

@@ -2476,8 +2464,7 @@
Return values
object — -
- +
api.php : - 284 - + 295 + +

Get user interaction statistics.

@@ -2502,8 +2490,7 @@

public getUserInteractionStatistics(string $requestId) : object -
- +

Parameters
@@ -2511,8 +2498,7 @@
Parameters
: string
-
- +
@@ -2534,8 +2520,7 @@
Return values
object — -
- +
+ 170 + +

Issue channel access token.

@@ -2560,8 +2546,7 @@

public issueChannelAccessToken(string $channelId, string $channelSecret) : object -
- +

Parameters
@@ -2569,16 +2554,14 @@
Parameters
: string
-
- +
$channelSecret : string
-
- +
@@ -2600,8 +2583,7 @@
Return values
object — -
- +
+ 311 + +

Issue link token.

@@ -2626,8 +2609,7 @@

public issueUserLinkToken(string $userId) : object -
- +

Parameters
@@ -2635,8 +2617,7 @@
Parameters
: string
-
- +
@@ -2658,8 +2639,7 @@
Return values
object — -
- +
+ 427 + +

Leave group.

@@ -2684,8 +2665,7 @@

public leaveGroup(string $groupId) : object -
- +

Parameters
@@ -2693,8 +2673,7 @@
Parameters
: string
-
- +
@@ -2716,8 +2695,7 @@
Return values
object — -
- +
+ 494 + +

Leave room.

@@ -2742,8 +2721,7 @@

public leaveRoom(string $roomId) : object -
- +

Parameters
@@ -2751,8 +2729,7 @@
Parameters
: string
-
- +
@@ -2774,8 +2751,7 @@
Return values
object — -
- +
+ 850 + +

Link rich menu to user.

@@ -2800,8 +2777,7 @@

public linkRichMenuToUser(string $userId, string $richMenuId) : object -
- +

Parameters
@@ -2809,16 +2785,14 @@
Parameters
: string
-
- +
$richMenuId : string
-
- +
@@ -2840,8 +2814,7 @@
Return values
object — -
- +
+ 574 + +

Send multicast message.

@@ -2866,8 +2840,7 @@

public multicast(array<string|int, mixed> $targetIds, array<string|int, mixed> $message[, bool $notificationDisabled = false ]) : object -
- +

Parameters
@@ -2875,16 +2848,14 @@
Parameters
: array<string|int, mixed>
-
- +
$message : array<string|int, mixed>
-
- +
$notificationDisabled @@ -2915,8 +2886,7 @@
Return values
object — -
- +
+ 939 + +

Verify the request which visits this API, if it's from LINE Webhook, parse the events.

@@ -2941,16 +2912,14 @@

public parseEvents() : array<string|int, mixed> -
- +

Return values
array<string|int, mixed> — -
- +
+ 543 + +

Send push message.

@@ -2975,8 +2945,7 @@

public pushMessage(string $targetId, array<string|int, mixed> $message[, bool $notificationDisabled = false ]) : object -
- +

Parameters
@@ -2984,16 +2953,14 @@
Parameters
: string
-
- +
$message : array<string|int, mixed>
-
- +
$notificationDisabled @@ -3024,8 +2991,7 @@
Return values
object — -
- +
+ 512 + +

Send reply message.

@@ -3050,8 +3017,7 @@

public replyMessage(string $replyToken, array<string|int, mixed> $message[, bool $notificationDisabled = false ]) : object -
- +

Parameters
@@ -3059,16 +3025,14 @@
Parameters
: string
-
- +
$message : array<string|int, mixed>
-
- +
$notificationDisabled @@ -3099,8 +3063,7 @@
Return values
object — -
- +
+ 212 + +

Revoke channel access token.

@@ -3125,8 +3089,7 @@

public revokeChannelAccessToken([string $channelAccessToken = "" ]) : bool -
- +

Parameters
@@ -3176,8 +3139,9 @@

+ 867 + +

Unlink rich menu from user.

@@ -3185,8 +3149,7 @@

public unlinkRichMenuFromUser(string $userId, string $richMenuId) : object -
- +

Parameters
@@ -3194,16 +3157,14 @@
Parameters
: string
-
- +
$richMenuId : string
-
- +
@@ -3225,8 +3186,7 @@
Return values
object — -
- +
+ 886 + +

Upload rich menu image. (libcURL used)

@@ -3251,8 +3212,7 @@

public uploadRichMenuImage(string $richMenuId, string $path) : void -
- +

Parameters
@@ -3260,16 +3220,14 @@
Parameters
: string
-
- +
$path : string
-
- +
@@ -3291,8 +3249,7 @@
Return values
void — -
- +
+ 993 + +

Send request to LINE API Platform.

@@ -3317,8 +3275,7 @@

private requestFactory(string $targetUri, int $method[, mixed $data = array() ][, bool $decode = true ]) : mixed -
- +

Parameters
@@ -3364,8 +3321,7 @@
Parameters
Return values
mixed — -
- +
+ 977 + +

Signing data via SHA-256.

@@ -3390,8 +3347,7 @@

private sign(mixed $body) : string -
- +

Parameters
@@ -3399,8 +3355,7 @@
Parameters
: mixed
-
- +
@@ -3409,12 +3364,73 @@
Parameters
Return values
string — -
- +
+ + +
@@ -3439,5 +3455,6 @@

Search results

+ diff --git a/docs/classes/LINEMSG-FlexContainer.html b/docs/classes/LINEMSG-FlexContainer.html old mode 100644 new mode 100755 index bf69dc4..4d7d0ba --- a/docs/classes/LINEMSG-FlexContainer.html +++ b/docs/classes/LINEMSG-FlexContainer.html @@ -15,6 +15,7 @@ + @@ -51,13 +52,12 @@

lin Menu

LINEMSG_FlexContainer

@@ -178,8 +185,9 @@

+ 1612 + + @@ -188,8 +196,8 @@

$object -
- + + @@ -213,15 +221,17 @@

+ 1614 + + public __construct(mixed $container) : mixed - +
+

Parameters
@@ -229,7 +239,8 @@
Parameters
: mixed
- +
+
@@ -238,8 +249,7 @@

Parameters
Return values
mixed — -
- +
+ 1651 + + public out() : mixed - +
+
Return values
mixed — -
- +
+ 1639 + + public set(mixed $var[, mixed $value = null ]) : mixed - +
+
Parameters
@@ -303,14 +316,16 @@
Parameters
: mixed
- +
+
$value : mixed = null
- +
+
@@ -319,12 +334,73 @@
Parameters
Return values
mixed — -
- +
+ + +
@@ -349,5 +425,6 @@

Search results

+ diff --git a/docs/classes/LINEMSG-Imagemap.html b/docs/classes/LINEMSG-Imagemap.html old mode 100644 new mode 100755 index 415ba8a..888acd5 --- a/docs/classes/LINEMSG-Imagemap.html +++ b/docs/classes/LINEMSG-Imagemap.html @@ -15,6 +15,7 @@ + @@ -51,13 +52,12 @@

lin Menu

LINEMSG_Imagemap

@@ -162,15 +169,17 @@

+ 1419 + + public action(mixed $type, mixed $url_or_text, mixed $area[, mixed $label = null ]) : mixed - +
+

Parameters
@@ -178,28 +187,32 @@
Parameters
: mixed
- +
+
$url_or_text : mixed
- +
+
$area : mixed
- +
+
$label : mixed = null
- +
+
@@ -208,8 +221,7 @@
Parameters
Return values
mixed — -
- +
+ 1436 + + public actionArea(mixed $x, mixed $y, mixed $width, mixed $height) : mixed - +
+
Parameters
@@ -241,28 +255,32 @@
Parameters
: mixed
- +
+
$y : mixed
- +
+
$width : mixed
- +
+
$height : mixed
- +
+
@@ -271,12 +289,73 @@
Parameters
Return values
mixed — -
- +
+ + +
@@ -301,5 +380,6 @@

Search results

+ diff --git a/docs/classes/LINEMSG-QuickReply.html b/docs/classes/LINEMSG-QuickReply.html old mode 100644 new mode 100755 index ad971b5..c35ce2f --- a/docs/classes/LINEMSG-QuickReply.html +++ b/docs/classes/LINEMSG-QuickReply.html @@ -15,6 +15,7 @@ + @@ -51,13 +52,12 @@

lin Menu

LINEMSG_QuickReply

@@ -206,8 +213,9 @@

+ 1306 + + @@ -216,8 +224,8 @@

$actions -
- + + @@ -237,8 +245,9 @@

+ 1311 + + @@ -247,8 +256,8 @@

$object -
- + + @@ -272,23 +281,24 @@

+ 1313 + + public __construct() : mixed - +
+

Return values
mixed — -
- +
+ 1335 + + public actions(mixed $type) : mixed - +
+
Parameters
@@ -320,7 +332,8 @@
Parameters
: mixed
- +
+
@@ -329,8 +342,7 @@
Parameters
Return values
mixed — -
- +
+ 1404 + + public actions_out() : mixed - +
+
Return values
mixed — -
- +
+ 1392 + + public actions_set(mixed $var[, mixed $value = null ]) : mixed - +
+
Parameters
@@ -394,14 +409,16 @@
Parameters
: mixed
- +
+
$value : mixed = null
- +
+
@@ -410,8 +427,7 @@
Parameters
Return values
mixed — -
- +
+ 1321 + + public add(mixed $action) : mixed - +
+
Parameters
@@ -443,7 +461,8 @@
Parameters
: mixed
- +
+
@@ -452,8 +471,7 @@
Parameters
Return values
mixed — -
- +
+ 1330 + + public out() : mixed - +
+
Return values
mixed — -
- +

+ + +
@@ -514,5 +595,6 @@

Search results

+ diff --git a/docs/classes/LINEMSG-Template.html b/docs/classes/LINEMSG-Template.html old mode 100644 new mode 100755 index 1c7983f..2b55a7f --- a/docs/classes/LINEMSG-Template.html +++ b/docs/classes/LINEMSG-Template.html @@ -15,6 +15,7 @@ + @@ -51,13 +52,12 @@

lin Menu

LINEMSG_Template

@@ -206,8 +213,9 @@

+ 1459 + + @@ -216,8 +224,8 @@

$actions -
- + + @@ -237,8 +245,9 @@

+ 1464 + + @@ -247,8 +256,8 @@

$object -
- + + @@ -272,15 +281,17 @@

+ 1466 + + public __construct(mixed $template) : mixed - +
+

Parameters
@@ -288,7 +299,8 @@
Parameters
: mixed
- +
+
@@ -297,8 +309,7 @@

Parameters

Return values
mixed — -
- +
+ 1525 + + public actions(mixed $type) : mixed - +
+
Parameters
@@ -330,7 +343,8 @@
Parameters
: mixed
- +
+
@@ -339,8 +353,7 @@
Parameters
Return values
mixed — -
- +
+ 1594 + + public actions_out() : mixed - +
+
Return values
mixed — -
- +
+ 1582 + + public actions_set(mixed $var[, mixed $value = null ]) : mixed - +
+
Parameters
@@ -404,14 +420,16 @@
Parameters
: mixed
- +
+
$value : mixed = null
- +
+
@@ -420,8 +438,7 @@
Parameters
Return values
mixed — -
- +
+ 1520 + + public out() : mixed - +
+
Return values
mixed — -
- +
+ 1508 + + public set(mixed $var[, mixed $value = null ]) : mixed - +
+
Parameters
@@ -485,14 +505,16 @@
Parameters
: mixed
- +
+
$value : mixed = null
- +
+
@@ -501,12 +523,73 @@
Parameters
Return values
mixed — -
- +
+ + +
@@ -531,5 +614,6 @@

Search results

+ diff --git a/docs/classes/LINEMSG.html b/docs/classes/LINEMSG.html old mode 100644 new mode 100755 index 20812a9..86b0553 --- a/docs/classes/LINEMSG.html +++ b/docs/classes/LINEMSG.html @@ -15,6 +15,7 @@ + @@ -51,13 +52,12 @@

lin Menu

LINEMSG

@@ -225,8 +232,9 @@

+ 1153 + +

Audio message

@@ -234,8 +242,7 @@

public static Audio(string $url[, int $second = null ]) : array<string|int, mixed> -
- +

Parameters
@@ -243,8 +250,7 @@
Parameters
: string
-
- +
$second @@ -275,8 +281,7 @@
Return values
array<string|int, mixed> — -
- +
+ 1283 + +

Change icon and display name

@@ -301,8 +307,7 @@

public static changeAppearance(array<string|int, mixed> $originalMessage, string $name, string $iconUrl) : array<string|int, mixed> -
- +

Parameters
@@ -310,24 +315,21 @@
Parameters
: array<string|int, mixed>
-
- +
$name : string
-
- +
$iconUrl : string
-
- +
@@ -350,8 +352,7 @@
Return values
array<string|int, mixed> — -
- +
+ 1257 + +

Flex Message

@@ -376,8 +378,7 @@

public static Flex(string $altText, array<string|int, mixed> $contents) : array<string|int, mixed> -
- +

Parameters
@@ -385,16 +386,14 @@
Parameters
: string
-
- +
$contents : array<string|int, mixed>
-
- +
@@ -416,8 +415,7 @@
Return values
array<string|int, mixed> — -
- +
+ 1111 + +

Image message

@@ -442,8 +441,7 @@

public static Image(string $url[, string $previewUrl = null ]) : array<string|int, mixed> -
- +

Parameters
@@ -451,8 +449,7 @@
Parameters
: string
-
- +
$previewUrl @@ -483,8 +480,7 @@
Return values
array<string|int, mixed> — -
- +
+ 1202 + +

Imagemap message

@@ -509,8 +506,7 @@

public static Imagemap(string $baseUrl, string $altText, int $width, int $height, array<string|int, mixed> $action) : array<string|int, mixed> -
- +

Parameters
@@ -518,40 +514,35 @@
Parameters
: string
-
- +
$altText : string
-
- +
$width : int
-
- +
$height : int
-
- +
$action : array<string|int, mixed>
-
- +
@@ -573,8 +564,7 @@
Return values
array<string|int, mixed> — -
- +
+ 1179 + +

Location message

@@ -599,8 +590,7 @@

public static Location(string $title, string $address, float $latitude, float $longitude) : array<string|int, mixed> -
- +

Parameters
@@ -608,32 +598,28 @@
Parameters
: string
-
- +
$address : string
-
- +
$latitude : float
-
- +
$longitude : float
-
- +
@@ -655,8 +641,7 @@
Return values
array<string|int, mixed> — -
- +
+ 1061 + +

Quick reply

@@ -681,8 +667,7 @@

public static QuickReply( $actions) : array<string|int, mixed> -
- +

Parameters
@@ -690,8 +675,7 @@
Parameters
:
-
- +
@@ -713,8 +697,7 @@
Return values
array<string|int, mixed> — -
- +
+ 1093 + +

Sticker message

@@ -739,8 +723,7 @@

public static Sticker(string $packageId, string $stickerId) : array<string|int, mixed> -
- +

Parameters
@@ -748,16 +731,14 @@
Parameters
: string
-
- +
$stickerId : string
-
- +
@@ -779,8 +760,7 @@
Return values
array<string|int, mixed> — -
- +
+ 1234 + +

Template messages

@@ -805,8 +786,7 @@

public static Template(string $altText, array<string|int, mixed> $template) : array<string|int, mixed> -
- +

Parameters
@@ -814,16 +794,14 @@
Parameters
: string
-
- +
$template : array<string|int, mixed>
-
- +
@@ -845,8 +823,7 @@
Return values
array<string|int, mixed> — -
- +
+ 1076 + +

Text message

@@ -871,8 +849,7 @@

public static Text(string $msgText) : array<string|int, mixed> -
- +

Parameters
@@ -880,8 +857,7 @@
Parameters
: string
-
- +
@@ -903,8 +879,7 @@
Return values
array<string|int, mixed> — -
- +
+ 1135 + +

Video message

@@ -929,8 +905,7 @@

public static Video(string $url, string $previewUrl) : array<string|int, mixed> -
- +

Parameters
@@ -938,16 +913,14 @@
Parameters
: string
-
- +
$previewUrl : string
-
- +
@@ -969,12 +942,73 @@
Return values
array<string|int, mixed> — -
- +
+ + +
@@ -999,5 +1033,6 @@

Search results

+ diff --git a/docs/css/base.css b/docs/css/base.css old mode 100644 new mode 100755 index 860d5f2..db4e807 --- a/docs/css/base.css +++ b/docs/css/base.css @@ -106,7 +106,6 @@ body { font-size: var(--text-xxxl); letter-spacing: var(--letter-spacing--primary); line-height: 1.25; - margin-top: 0; } .phpdocumentor h3 { @@ -168,6 +167,12 @@ body { .phpdocumentor figure { margin-bottom: var(--spacing-md); } + +.phpdocumentor figcaption { + text-align: center; + font-style: italic; + font-size: 80%; +} .phpdocumentor-line { border-top: 1px solid #E1E1E1; border-width: 0; @@ -460,6 +465,14 @@ ol.phpdocumentor-list ul.phpdocumentor-list { li.phpdocumentor-list { margin-bottom: var(--spacing-md); } + +.phpdocumentor dl dt { + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor dl dd { + margin-bottom: var(--spacing-md); +} .phpdocumentor pre { margin-bottom: var(--spacing-md); } @@ -1012,8 +1025,63 @@ td.phpdocumentor-cell:last-child { border-radius: 3px; } } +.phpdocumentor-modal { + position: fixed; + width: 100vw; + height: 100vh; + opacity: 0; + visibility: hidden; + transition: all 0.3s ease; + top: 0; + left: 0; + display: flex; + align-items: center; + justify-content: center; +} + +.phpdocumentor-modal__open { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} + +.phpdocumentor-modal-bg { + position: absolute; + background: gray; + opacity: 50%; + width: 100%; + height: 100%; +} + +.phpdocumentor-modal-container { + border-radius: 1em; + background: #fff; + position: relative; + padding: 2em; +} + +.phpdocumentor-modal__close { + position: absolute; + right: 0.75em; + top: 0.75em; + outline: none; + appearance: none; + color: var(--primary-color); + background: none; + border: 0px; + font-weight: bold; + cursor: pointer; +} /* Used for screen readers and such */ .visually-hidden { display: none; } + +.float-right { + float: right; +} + +.float-left { + float: left; +} diff --git a/docs/css/normalize.css b/docs/css/normalize.css old mode 100644 new mode 100755 diff --git a/docs/css/template.css b/docs/css/template.css old mode 100644 new mode 100755 index fb905f3..31f00e3 --- a/docs/css/template.css +++ b/docs/css/template.css @@ -153,6 +153,25 @@ font-size: var(--text-sm); color: gray; } + +.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source { + flex: 0 1 auto; + display: inline-flex; +} + +.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source:after { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + left: 0; + border-radius: 50%; + font-weight: 600; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} .phpdocumentor-class-graph { width: 100%; height: 600px; border:1px solid black; overflow: hidden } diff --git a/docs/files/api.html b/docs/files/api.html old mode 100644 new mode 100755 index 043f395..265c49e --- a/docs/files/api.html +++ b/docs/files/api.html @@ -15,6 +15,7 @@ + @@ -51,13 +52,12 @@

lin Menu + + hash_equals(mixed $knownString, mixed $userString) : mixed - +
+

Parameters
@@ -204,19 +205,25 @@
Parameters
: mixed
- +
+
$userString : mixed
- +
+
+
Return values
+ mixed + — +
@@ -245,5 +252,6 @@

Search results

+ diff --git a/docs/files/examples-echo-bot.html b/docs/files/examples-echo-bot.html old mode 100644 new mode 100755 index f9a7da1..b16170e --- a/docs/files/examples-echo-bot.html +++ b/docs/files/examples-echo-bot.html @@ -15,6 +15,7 @@ + @@ -51,13 +52,12 @@

lin Menu

@@ -190,5 +198,6 @@

Search results

+ diff --git a/docs/packages/Application.html b/docs/packages/Application.html new file mode 100644 index 0000000..7525032 --- /dev/null +++ b/docs/packages/Application.html @@ -0,0 +1,203 @@ + + + + + line-bot-sdk-php-tiny + + + + + + + + + + + + + + + + + + + +
+

line-bot-sdk-php-tiny

+ + +
+ +
+ + +
+ +
+
+ + + + +
+
    +
+ +
+

Application

+ + + +

+ Interfaces, Classes and Traits + +

+ +
+ +
LINEAPI
+
LINEAPI (Messaging API)
+
LINEMSG
+
LINEMSG
+
LINEMSG_QuickReply
+
LINEMSG_QuickReply
+
LINEMSG_Imagemap
+
LINEMSG_Imagemap
+
LINEMSG_Template
+
LINEMSG_Template
+
LINEMSG_FlexContainer
+
LINEMSG_FlexContainer
+ +
+ + +

+ Table of Contents + +

+ +
+
+ hash_equals() + +  : mixed +
+
+ +
+ + + +
+

+ Functions + +

+
+

+ hash_equals() + +

+ + + + + + hash_equals(mixed $knownString, mixed $userString) : mixed + +
+ +
Parameters
+
+
+ $knownString + : mixed +
+
+
+ +
+
+ $userString + : mixed +
+
+
+ +
+
+ + + +
Return values
+ mixed + — + + +
+
+ +
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    +
    + + +
    + + + + + + + + diff --git a/docs/packages/Default.html b/docs/packages/Default.html old mode 100644 new mode 100755 diff --git a/docs/packages/default.html b/docs/packages/default.html old mode 100644 new mode 100755 index 459b6fe..92d2ea9 --- a/docs/packages/default.html +++ b/docs/packages/default.html @@ -15,6 +15,7 @@ + @@ -51,13 +52,12 @@

    lin Menu