### Install Composer and Run Bot Source: https://github.com/line/line-bot-sdk-php/blob/master/examples/EchoBot/README.md Commands to install Composer, install project dependencies, configure bot information, and start the development server. ```bash $ curl -sS https://getcomposer.org/installer | php # Install composer.phar $ ./composer.phar install $ $EDITOR ./src/LINEBot/EchoBot/Setting.php # <= edit your bot information $ php -S 0.0.0.0:8080 -t public ``` -------------------------------- ### setUp() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Test-Model-PnpDeliveryTest.html Setup before running each test case. ```APIDOC ## setUp() ### Description Setup before running each test case. ### Method public ### Signature `setUp(): void` ``` -------------------------------- ### Install Development Dependencies Source: https://github.com/line/line-bot-sdk-php/blob/master/CONTRIBUTING.md Run this command to install all necessary dependencies for development. This includes tools for testing, code analysis, and code generation. ```bash composer install ``` -------------------------------- ### Install Composer and Dependencies Source: https://github.com/line/line-bot-sdk-php/blob/master/examples/KitchenSink/README.md Commands to install Composer and project dependencies. ```bash $ curl -sS https://getcomposer.org/installer | php # Install composer.phar $ ./composer.phar install ``` -------------------------------- ### Install LINE Messaging API SDK for PHP Source: https://github.com/line/line-bot-sdk-php/blob/master/README.md Install the SDK using Composer. Ensure you are using PHP 8.2 or later. ```bash $ composer require linecorp/line-bot-sdk ``` -------------------------------- ### setUpBeforeClass() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Test-Model-PnpDeliveryTest.html Setup before running any test case. ```APIDOC ## setUpBeforeClass() ### Description Setup before running any test case. ### Method public static ### Signature `setUpBeforeClass(): void` ``` -------------------------------- ### getStartTimestamp() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-CouponResponse.html Gets the start timestamp for the coupon's validity. ```APIDOC ## getStartTimestamp() ### Description Gets the start timestamp for the coupon's validity. ### Method `public getStartTimestamp()` ### Return Values - `int|null`: The start timestamp or null if not set. ``` -------------------------------- ### Run the Application Source: https://github.com/line/line-bot-sdk-php/blob/master/examples/KitchenSink/README.md Start the PHP server with the specified port. ```bash $ ./run.sh 8080 ``` -------------------------------- ### Mentionee Get Length Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Model-Mentionee.html Gets the length of the mentionee. ```APIDOC ## getLength() ### Description Gets length. ### Return values int ``` -------------------------------- ### Mentionee Get Index Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Model-Mentionee.html Gets the index of the mentionee. ```APIDOC ## getIndex() ### Description Gets index. ### Return values int ``` -------------------------------- ### Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Configuration.html Initializes a new instance of the Configuration class. ```APIDOC ## Constructor ### Description Initializes a new instance of the Configuration class. This method can be used to set up the initial configuration for the LINE Messaging API client. ### Method `__construct()` ### Parameters None ``` -------------------------------- ### QuickReplyItem Constructor and Setters Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-QuickReplyItem.html Demonstrates how to instantiate the QuickReplyItem model and set its properties using available setter methods. ```APIDOC ## __construct() ### Description Constructor for the QuickReplyItem model. ### Method `__construct()` ### Parameters None explicitly documented for direct instantiation. ## setAction(Action $action) ### Description Sets the action associated with the quick reply item. ### Method `setAction(Action $action)` ### Parameters - **action** (Action) - Required - The action to be performed when the quick reply item is tapped. ### Return - self: Returns the instance of the QuickReplyItem for method chaining. ## setImageUrl(string $imageUrl) ### Description Sets the image URL for the quick reply item. ### Method `setImageUrl(string $imageUrl)` ### Parameters - **imageUrl** (string) - Required - The URL of the image to display for the quick reply item. ### Return - self: Returns the instance of the QuickReplyItem for method chaining. ## setType(string $type) ### Description Sets the type of the quick reply item. ### Method `setType(string $type)` ### Parameters - **type** (string) - Required - The type of the quick reply item (e.g., 'message', 'camera', 'cameraRoll', 'location'). ### Return - self: Returns the instance of the QuickReplyItem for method chaining. ``` -------------------------------- ### Get Header Value Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-SetWebhookEndpointRequest.html Gets a header-safe presentation of the SetWebhookEndpointRequest object. ```APIDOC ## toHeaderValue() ### Description Gets a header-safe presentation of the object. ### Method `toHeaderValue` ### Return values string ``` -------------------------------- ### Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-Liff-Configuration.html Initializes the LIFF configuration with optional default settings. ```APIDOC ## __construct() ### Description Initializes the LIFF configuration. It can optionally accept a default configuration array. ### Method __construct(array $defaultConfiguration = []) ### Parameters #### Arguments - **defaultConfiguration** (array) - Optional. An array containing default configuration values. ``` -------------------------------- ### DummyApi::__construct Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Api-DummyApi.html Initializes the DummyApi with optional client, configuration, and header selector. ```APIDOC ## __construct() ### Description Initializes the DummyApi with optional client, configuration, and header selector. ### Parameters - **$client** (ClientInterface) - Optional client instance. - **$config** (Configuration) - Optional configuration object. - **$selector** (HeaderSelector) - Optional header selector instance. - **$hostIndex** (int) - Optional host index to select from defined hosts. ``` -------------------------------- ### Get Message Content Preview Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Api-MessagingApiBlobApi.html Retrieves a preview of message content. This method is useful for getting a small representation of the content without downloading the entire file. ```APIDOC ## GET /v2/bot/message/{messageId}/content/preview ### Description Retrieves a preview of message content. ### Method GET ### Endpoint /v2/bot/message/{messageId}/content/preview ### Parameters #### Path Parameters - **messageId** (string) - Required - The message ID of the message for which to get the content preview. ``` -------------------------------- ### setUploadDescription() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-ManageAudience-Model-CreateAudienceGroupRequest.html Sets the description for the audience group upload job. ```APIDOC ## setUploadDescription() ### Description Sets the description to register for the job. ### Method `public setUploadDescription(string|null $uploadDescription): self` ### Parameters * **$uploadDescription** (string|null) - The description to register for the job (in jobs[].description). ``` -------------------------------- ### offsetGet() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-Insight-Model-GetMessageEventResponseClick.html Gets offset. ```APIDOC ## offsetGet() ### Description Gets offset. ### Parameters - **offset** (int) - Offset ### Return values mixed|null ``` -------------------------------- ### Get Webhook Endpoint Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Api-MessagingApiApi.html Retrieves the webhook endpoint URL configured for the LINE channel. This includes methods for synchronous and asynchronous calls, as well as methods to get HTTP information and request objects. ```APIDOC ## getWebhookEndpoint ### Description Retrieves the webhook endpoint URL configured for the LINE channel. ### Method [HTTP_METHOD] ### Endpoint [ENDPOINT] ### Parameters None ### Request Example None ### Response #### Success Response (200) - **webhookEndpointUrl** (string) - The webhook endpoint URL. #### Response Example { "webhookEndpointUrl": "https://example.com/webhook" } ``` -------------------------------- ### QuickReply Methods Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-QuickReply.html This section outlines the available methods for interacting with the QuickReply model, including constructors, getters, setters, and utility functions for serialization and validation. ```APIDOC ## Class: QuickReply ### Description Represents a QuickReply object for the LINE Messaging API. ### Methods #### `__construct()` - **Description**: Constructor for the QuickReply class. - **Returns**: `mixed` #### `__toString()` - **Description**: Gets the string representation of the QuickReply object. - **Returns**: `string` #### `attributeMap()` - **Description**: Returns an array mapping local attribute names to their original names. - **Returns**: `array` #### `getItems()` - **Description**: Gets the list of QuickReplyItem objects associated with this QuickReply. - **Returns**: `array|null` #### `getModelName()` - **Description**: Returns the original name of the model. - **Returns**: `string` #### `getters()` - **Description**: Returns an array mapping attribute names to their getter functions for serialization. - **Returns**: `array` #### `isNullable()` - **Description**: Checks if a property is nullable. - **Returns**: `bool` #### `isNullableSetToNull()` - **Description**: Checks if a nullable property has been explicitly set to null. - **Returns**: `bool` #### `jsonSerialize()` - **Description**: Serializes the object into a native JSON-encodable format. - **Returns**: `mixed` #### `listInvalidProperties()` - **Description**: Lists all invalid properties of the model and the reasons for their invalidity. - **Returns**: `array` #### `offsetExists()` - **Description**: Checks if an offset exists in the object. - **Returns**: `bool` #### `offsetGet()` - **Description**: Retrieves the value at a specified offset. - **Returns**: `mixed|null` #### `offsetSet()` - **Description**: Sets a value at a specified offset. - **Parameters**: - `offset` (mixed): The offset to set. - `value` (mixed): The value to set. - **Returns**: `void` #### `offsetUnset()` - **Description**: Unsets the value at a specified offset. - **Parameters**: - `offset` (mixed): The offset to unset. - **Returns**: `void` #### `openAPIFormats()` - **Description**: Returns an array mapping property names to their OpenAPI format. - **Returns**: `array` #### `openAPITypes()` - **Description**: Returns an array mapping property names to their OpenAPI type. - **Returns**: `array` #### `setItems()` - **Description**: Sets the list of QuickReplyItem objects for this QuickReply. - **Parameters**: - `items` (array): The array of QuickReplyItem objects. - **Returns**: `self` #### `setters()` - **Description**: Returns an array mapping attribute names to their setter functions for deserialization. - **Returns**: `array` #### `toHeaderValue()` - **Description**: Gets a header-safe string representation of the object. - **Returns**: `string` #### `valid()` - **Description**: Validates all properties of the model. - **Returns**: `bool` #### `openAPINullables()` - **Description**: Returns an array of nullable properties. - **Returns**: `array` #### `getOpenAPINullablesSetToNull()` - **Description**: Returns an array indicating which nullable properties have been set to null. - **Returns**: `array` #### `setIfExists()` - **Description**: Sets a property if it exists in the provided data or default value, handling nullability. - **Parameters**: - `variableName` (string): The name of the variable to set. - `data` (mixed): The data to set. - `defaultValue` (mixed): The default value to use if data is not provided. - **Returns**: `void` #### `setOpenAPINullablesSetToNull()` - **Description**: Sets the array indicating which nullable properties are deliberately set to null. - **Parameters**: - `openAPINullablesSetToNull` (array): An array indicating nullable properties set to null. - **Returns**: `void` ### Constants #### `DISCRIMINATOR` - **Description**: Discriminator for the model, typically used for inheritance. - **Value**: `null` ``` -------------------------------- ### QuickReply Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-QuickReply.html Initializes a new instance of the QuickReply class, optionally with an associative array of property values. ```APIDOC ## __construct() ### Description Initializes a new instance of the QuickReply class. ### Method `__construct([array|null $data = null])` ### Parameters * **$data** (array|null) - Optional - An associative array of property values to initialize the model. ``` -------------------------------- ### Get Room Member Profile Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Api-MessagingApiApi.html Retrieves the profile information of a member in a specific room. This includes methods for synchronous and asynchronous calls, as well as methods to get HTTP information and request objects. ```APIDOC ## getRoomMemberProfile ### Description Retrieves the profile information of a member in a specific room. ### Method [HTTP_METHOD] ### Endpoint [ENDPOINT] ### Parameters #### Path Parameters - **roomId** (string) - Required - The ID of the room. - **userId** (string) - Required - The ID of the user. #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **displayName** (string) - The display name of the user. - **pictureUrl** (string) - The URL of the user's profile picture. - **statusMessage** (string) - The status message of the user. #### Response Example { "displayName": "LINE User", "pictureUrl": "https://example.com/profile.jpg", "statusMessage": "Hello!" } ``` -------------------------------- ### Get Room Members IDs Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Api-MessagingApiApi.html Retrieves a list of user IDs for all members in a specific room. This includes methods for synchronous and asynchronous calls, as well as methods to get HTTP information and request objects. ```APIDIDOC ## getRoomMembersIds ### Description Retrieves a list of user IDs for all members in a specific room. ### Method [HTTP_METHOD] ### Endpoint [ENDPOINT] ### Parameters #### Path Parameters - **roomId** (string) - Required - The ID of the room. #### Query Parameters - **start** (string) - Optional - The starting point for the user IDs to retrieve. Use this parameter in conjunction with the `limit` parameter to paginate through the results. - **limit** (integer) - Optional - The maximum number of user IDs to return. Defaults to 100. #### Request Body None ### Request Example None ### Response #### Success Response (200) - **memberIds** (array) - An array of user IDs. - **next** (string) - A token to retrieve the next page of results. If this is not included in the response, there are no more results. #### Response Example { "memberIds": ["Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], "next": "nextToken" } ``` -------------------------------- ### QuickReplyItem Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-QuickReplyItem.html Initializes a new instance of the QuickReplyItem class, optionally with provided data. ```APIDOC ## __construct() ### Description Constructor for the QuickReplyItem model. ### Parameters - **$data** (array|null) - Optional - Associated array of property values initializing the model. ### Return values mixed ``` -------------------------------- ### getType() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Model-PostbackEvent.html Gets the type of the event. ```APIDOC ## getType() ### Description Gets the type of the event. ### Method `public getType() : string` ### Return values string ``` -------------------------------- ### QuickReply Model Methods Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-QuickReply.html This section details the available methods for the QuickReply model, including constructors, getters, setters, and methods for attribute mapping and validation. ```APIDOC ## QuickReply Model Methods ### Description Provides methods for initializing, managing, and serializing the QuickReply model. ### Methods * **`__construct()`**: Initializes a new instance of the QuickReply model. * **`__toString()`**: Returns a string representation of the QuickReply object. * **`attributeMap()`**: Returns the attribute map for the model. * **`getItems()`**: Retrieves the quick reply items. * **`getModelName()`**: Gets the name of the model. * **`getters()`**: Returns the getters for the model. * **`isNullable()`**: Checks if a property is nullable. * **`isNullableSetToNull()`**: Checks if a nullable property is set to null. * **`jsonSerialize()`**: Serializes the model to a JSON-compatible representation. * **`listInvalidProperties()`**: Lists invalid properties of the model. * **`offsetExists()`**: Checks if an offset exists. * **`offsetGet()`**: Gets the value at a specified offset. * **`offsetSet()`**: Sets the value at a specified offset. * **`offsetUnset()`**: Unsets the value at a specified offset. * **`openAPIFormats()`**: Returns the OpenAPI formats for the model. * **`openAPITypes()`**: Returns the OpenAPI types for the model. * **`setItems()`**: Sets the quick reply items. * **`setters()`**: Returns the setters for the model. * **`toHeaderValue()`**: Converts the model to a header value. * **`valid()`**: Validates the model. * **`openAPINullables()`**: Returns the nullable properties of the model. * **`getOpenAPINullablesSetToNull()`**: Gets the nullable properties set to null. * **`setIfExists()`**: Sets a property if it exists. * **`setOpenAPINullablesSetToNull()`**: Sets the nullable properties to null. ``` -------------------------------- ### getType() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Model-ScenarioResultThingsContent.html Gets the type of the content. ```APIDOC ## getType() ### Description Gets the type. ### Method `public getType() : string` ### Return values `string` ``` -------------------------------- ### getType() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-RichMenuBatchUnlinkOperation.html Gets the type of the operation. ```APIDOC ## getType() ### Description Gets the type of the operation. ### Method `public getType() : string` ### Return values string ``` -------------------------------- ### CashBackPriceInfoResponse Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-CashBackPriceInfoResponse.html Initializes a new instance of the CashBackPriceInfoResponse class with optional data. ```APIDOC ## __construct() ### Description Constructor for the CashBackPriceInfoResponse model. ### Parameters * **$data** (array|null) - Optional. Associated array of property values initializing the model. ### Return values void ``` -------------------------------- ### RichMenuBounds Constructor and Getters Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-RichMenuBounds.html Demonstrates the constructor and getter methods for the RichMenuBounds model, used to initialize and retrieve its properties. ```APIDOC ## RichMenuBounds Constructor and Getters ### Description This section covers the initialization and retrieval of properties for the `RichMenuBounds` model. ### Methods #### `__construct()` - **Description**: Constructor for the `RichMenuBounds` model. - **Returns**: `mixed` #### `getX()` - **Description**: Gets the x-coordinate of the bounds. - **Returns**: `int|null` #### `getY()` - **Description**: Gets the y-coordinate of the bounds. - **Returns**: `int|null` #### `getWidth()` - **Description**: Gets the width of the bounds. - **Returns**: `int|null` #### `getHeight()` - **Description**: Gets the height of the bounds. - **Returns**: `int|null` ``` -------------------------------- ### getValue() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-MessageQuotaResponse.html Gets the value of the quota. ```APIDOC ## getValue() ### Description Gets value ### Method `public getValue() : int|null` ### Return values int|null ``` -------------------------------- ### LiffView Constructor and Basic Getters Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-Liff-Model-LiffView.html Details on how to instantiate the LiffView model and retrieve its basic properties. ```APIDOC ## __construct() ### Description Constructor for the LiffView model. ### Method __construct() ### Parameters None explicitly documented. ## getType() ### Description Gets the type of the LIFF view. ### Method getType() ### Parameters None. ### Returns string - The type of the LIFF view. ## getUrl() ### Description Gets the URL of the LIFF application. ### Method getUrl() ### Parameters None. ### Returns string - The URL of the LIFF application. ``` -------------------------------- ### getType() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-MessageQuotaResponse.html Gets the type of the quota. ```APIDOC ## getType() ### Description Gets type ### Method `public getType() : [QuotaType](classes/LINE-Clients-MessagingApi-Model-QuotaType.html)` ### Return values [QuotaType](classes/LINE-Clients-MessagingApi-Model-QuotaType.html) ``` -------------------------------- ### CashBackFixedPriceInfoResponse Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-CashBackFixedPriceInfoResponse.html Initializes a new instance of the CashBackFixedPriceInfoResponse model. ```APIDOC ## `__construct()` ### Description Constructor for the CashBackFixedPriceInfoResponse model. ### Parameters - **$data** (`array`|null) - Optional. Associated array of property values initializing the model. ### Return values - `mixed` ``` -------------------------------- ### getType() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-FlexComponent.html Gets the type of the FlexComponent. ```APIDOC ## getType() ### Description Gets the type of the FlexComponent. ### Method `public getType() : string` ### Return Values The string representing the type of the FlexComponent. ``` -------------------------------- ### getType() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-DatetimePickerAction.html Gets the type of the action. ```APIDOC ## getType() ### Description Gets the type of the action. ### Method `public getType() : string|null` ### Return values `string|null` ``` -------------------------------- ### Create Bot Client Instance Source: https://github.com/line/line-bot-sdk-php/blob/master/README.md Instantiate the bot client, which acts as the handler for the Messaging API. Ensure you use a GuzzleHttp\ClientInterface implementation. ```APIDOC ## Create Bot Client Instance ### Description Instantiate the bot client, which acts as the handler for the Messaging API. Ensure you use a `GuzzleHttp\ClientInterface` implementation. ### Code ```php $client = new \GuzzleHttp\Client(); $config = new \LINE\Clients\MessagingApi\Configuration(); $config->setAccessToken(''); $messagingApi = new \LINE\Clients\MessagingApi\Api\MessagingApi( client: $client, config: $config, ); ``` ``` -------------------------------- ### getTitle() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-CouponListResponse.html Gets the title of the coupon. ```APIDOC ## getTitle() ### Description Gets the title of the coupon. ### Method `public getTitle() : string` ### Return values string ``` -------------------------------- ### LINE-Clients-Insight-Configuration Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-Insight-Configuration.html Initializes a new instance of the LINE-Clients-Insight-Configuration class. ```APIDOC ## __construct() ### Description Initializes a new instance of the LINE-Clients-Insight-Configuration class. ### Method __construct ``` -------------------------------- ### CouponListResponse Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-CouponListResponse.html Initializes a new instance of the CouponListResponse model, optionally with provided data. ```APIDOC ## __construct() ### Description Constructor for the CouponListResponse class. ### Parameters - **data** (array|null) - Optional - Associated array of property values initializing the model. ### Return values - mixed ``` -------------------------------- ### getCouponId() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-CouponListResponse.html Gets the coupon ID. ```APIDOC ## getCouponId() ### Description Gets the coupon ID. ### Method `public getCouponId() : string` ### Return values string ``` -------------------------------- ### CouponRewardResponse Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-CouponRewardResponse.html Initializes a new instance of the CouponRewardResponse class, optionally with provided data. ```APIDOC ## __construct() ### Description Constructor for the CouponRewardResponse model. ### Parameters - **$data** (array|null) - Optional. An associative array of property values to initialize the model. ### Return values - mixed ``` -------------------------------- ### getPermission() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-ManageAudience-Model-CreateClickBasedAudienceGroupResponse.html Gets the permission from the response. ```APIDOC ## getPermission() ### Description Gets the permission from the response. ### Method `public getPermission() : string|null` ### Return values string|null ``` -------------------------------- ### GetAllLiffAppsResponse Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-Liff-Model-GetAllLiffAppsResponse.html Initializes a new instance of the GetAllLiffAppsResponse class with optional data. ```APIDOC ## __construct() ### Description Constructor for the GetAllLiffAppsResponse class. ### Parameters * **$data** (array|null) - Optional. An associative array of property values to initialize the model. ### Return values `mixed` ``` -------------------------------- ### getDescription() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-ManageAudience-Model-CreateClickBasedAudienceGroupResponse.html Gets the description from the response. ```APIDOC ## getDescription() ### Description Gets the description from the response. ### Method `public getDescription() : string|null` ### Return values string|null ``` -------------------------------- ### getName() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-ManageAudience-Model-DetailedOwner.html Gets the name of the owner. ```APIDOC ## getName() ### Description Gets the name of the owner. ### Method `public getName() : string|null` ### Return values `string|null` ``` -------------------------------- ### __construct() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-Liff-Configuration.html Constructor for the LINE-Clients-Liff-Configuration class. Initializes a new instance of the configuration. ```APIDOC ## __construct() ### Description Constructor for the LINE-Clients-Liff-Configuration class. Initializes a new instance of the configuration. ### Method Constructor ### Parameters None explicitly documented. ``` -------------------------------- ### getId() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-ManageAudience-Model-DetailedOwner.html Gets the ID of the owner. ```APIDOC ## getId() ### Description Gets the ID of the owner. ### Method `public getId() : string|null` ### Return values `string|null` ``` -------------------------------- ### getHostSettings() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-ChannelAccessToken-Configuration.html Retrieves an array of host settings. ```APIDOC ## getHostSettings() ### Description Returns an array of host settings. ### Method `public getHostSettings() : array` ### Return values array — an array of host settings ``` -------------------------------- ### getSubscriptionPeriod() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-Insight-Model-SubscriptionPeriodTile.html Gets the subscription period. ```APIDOC ## getSubscriptionPeriod() ### Description Gets subscriptionPeriod ### Method `public getSubscriptionPeriod() : string|null` ### Return values string|null ``` -------------------------------- ### QuickReplyItem Methods Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-QuickReplyItem.html This section covers methods for setting properties, retrieving type information, and validating the QuickReplyItem model. ```APIDOC ## QuickReplyItem Methods ### `offsetSet(int|null $offset, mixed $value): void` Sets value based on offset. ### `offsetUnset(int $offset): void` Unsets offset. ### `openAPIFormats(): array` Array of property to format mappings. Used for (de)serialization. ### `openAPITypes(): array` Array of property to type mappings. Used for (de)serialization. ### `setAction(?Action $action): self` Sets action. ### `setImageUrl(?string $imageUrl): self` Sets imageUrl. ### `setters(): array` Array of attributes to setter functions (for deserialization of responses). ### `setType(?string $type): self` Sets type. ### `toHeaderValue(): string` Gets a header-safe presentation of the object. ### `valid(): bool` Validate all the properties in the model return true if all passed. ``` -------------------------------- ### AppTypeTile Constructor and Basic Methods Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-Insight-Model-AppTypeTile.html Provides details on the constructor and basic methods for the AppTypeTile model. ```APIDOC ## __construct() ### Description Constructor for the AppTypeTile model. ### Method __construct() ### Parameters None explicitly documented for direct use in this context. ``` ```APIDOC ## __toString() ### Description Gets the string presentation of the AppTypeTile object. ### Method __toString() ### Returns string: The string representation of the object. ``` ```APIDOC ## getAppType() ### Description Gets the appType property of the AppTypeTile. ### Method getAppType() ### Returns string|null: The appType value. ``` ```APIDOC ## getPercentage() ### Description Gets the percentage property of the AppTypeTile. ### Method getPercentage() ### Returns float|null: The percentage value. ``` -------------------------------- ### getQuoteToken Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Model-VideoMessageContent.html Gets the token for quoting the message. ```APIDOC ## getQuoteToken ### Description Gets the token for quoting the message. ### Method `public getQuoteToken()` ### Return values `string` ``` -------------------------------- ### __construct() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-Insight-Configuration.html Constructor for the Configuration class. ```APIDOC ## __construct() ### Description Constructor for the Configuration class. ### Method __construct ``` -------------------------------- ### Get Mode Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Model-PostbackEvent.html Retrieves the mode of the event. ```APIDOC ## getMode() ### Description Gets mode. ### Method `public getMode(): [EventMode](classes/LINE-Webhook-Model-EventMode.html)` ### Return values [EventMode](classes/LINE-Webhook-Model-EventMode.html) - The event mode. ``` -------------------------------- ### Create Bot Client Instance Source: https://github.com/line/line-bot-sdk-php/blob/master/README.md Instantiate the bot client, which handles Messaging API operations. You must use a GuzzleHttp\ClientInterface implementation. ```php $client = new \GuzzleHttp\Client(); $config = new \LINE\Clients\MessagingApi\Configuration(); $config->setAccessToken(''); $messagingApi = new \LINE\Clients\MessagingApi\Api\MessagingApiApi( client: $client, config: $config, ); ``` -------------------------------- ### getType() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Model-MembershipContent.html Gets the type of the membership content. ```APIDOC ## getType() ### Description Gets the type of the membership content. ### Method `public getType() : string` ### Return values string - The type of the membership content. ``` -------------------------------- ### CashBackPercentagePriceInfoResponse Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-CashBackPercentagePriceInfoResponse.html Initializes a new instance of the CashBackPercentagePriceInfoResponse class with optional data. ```APIDOC ## __construct() ### Description Constructor for the CashBackPercentagePriceInfoResponse model. ### Parameters - **data** (array|null) - Optional - Associated array of property values initializing the model. ### Method `public __construct([array|null $data = null]) : mixed` ``` -------------------------------- ### getType Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Model-AudioMessageContent.html Gets the type of the message content. ```APIDOC ## getType ### Description Gets the type of the message content. ### Method `public getType()` ### Return values `string` ``` -------------------------------- ### CouponOthersRewardResponse Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-CouponOthersRewardResponse.html Initializes a new instance of the CouponOthersRewardResponse class with optional data. ```APIDOC ## __construct() ### Description Constructor for the CouponOthersRewardResponse model. ### Method `__construct([array|null $data = null])` ### Parameters - **$data** (array|null) - Optional. An associative array of property values to initialize the model. ### Return values Mixed ``` -------------------------------- ### Event Mode Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Model-BotSuspendedEvent.html Gets the mode of the event. ```APIDOC ## getMode() ### Description Gets mode. ### Return values [EventMode](classes/LINE-Webhook-Model-EventMode.html) ``` -------------------------------- ### __construct() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-Insight-Model-AppTypeTile.html Initializes a new instance of the AppTypeTile class, optionally with provided data. ```APIDOC ## __construct() ### Description Constructor for the AppTypeTile class. It can be initialized with an optional associative array of data. ### Method `public __construct([array|null $data = null]) : mixed` ### Parameters - **$data** (array|null) - Optional - Associated array of property values initializing the model. ``` -------------------------------- ### Event getMode() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Model-BotResumedEvent.html Gets the mode of the event. ```APIDOC ## getMode() ### Description Gets mode. ### Return values - **[EventMode](classes/LINE-Webhook-Model-EventMode.html)** - The event mode. ``` -------------------------------- ### setUpToRemainingQuota Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-Limit.html Sets the upToRemainingQuota option. If true, the message will be sent within the maximum number of deliverable messages, with targets selected at random. The default value is false. ```APIDOC ## setUpToRemainingQuota(bool|null $upToRemainingQuota) ### Description Sets upToRemainingQuota. If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random. ### Parameters - **upToRemainingQuota** (bool|null) - Description of the parameter as provided in the source. ``` -------------------------------- ### Methods Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-DiscountFixedPriceInfoResponse.html Details the constructor method for the DiscountFixedPriceInfoResponse class. ```APIDOC ## Methods ### __construct() **Description:** Constructor for the DiscountFixedPriceInfoResponse class. **Return Type:** mixed ``` -------------------------------- ### getType() Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Webhook-Model-ActionResult.html Gets the type of the action result. ```APIDOC ## getType() ### Description Gets type. ### Method `public getType() : string` ### Return values string — The type of the action result. ``` -------------------------------- ### CouponGiftRewardResponse Constructor Source: https://github.com/line/line-bot-sdk-php/blob/master/docs/classes/LINE-Clients-MessagingApi-Model-CouponGiftRewardResponse.html Initializes a new instance of the CouponGiftRewardResponse class with optional initial data. ```APIDOC ## __construct() ### Description Constructor for the CouponGiftRewardResponse model. ### Parameters - **data** (array|null) - Optional - Associated array of property values initializing the model. ### Return values - mixed ```