LINE Messaging API SDK for PHP

ManageAudienceBlobApi
in package

ManageAudienceBlobApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['addUserIdsToAudience' => ['multipart/form-data'], 'createAudienceForUploadingUserIds' => ['multipart/form-data']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
addUserIdsToAudience()  : void
Operation addUserIdsToAudience
addUserIdsToAudienceAsync()  : PromiseInterface
Operation addUserIdsToAudienceAsync
addUserIdsToAudienceAsyncWithHttpInfo()  : PromiseInterface
Operation addUserIdsToAudienceAsyncWithHttpInfo
addUserIdsToAudienceRequest()  : Request
Create request for operation 'addUserIdsToAudience'
addUserIdsToAudienceWithHttpInfo()  : array<string|int, mixed>
Operation addUserIdsToAudienceWithHttpInfo
createAudienceForUploadingUserIds()  : CreateAudienceGroupResponse
Operation createAudienceForUploadingUserIds
createAudienceForUploadingUserIdsAsync()  : PromiseInterface
Operation createAudienceForUploadingUserIdsAsync
createAudienceForUploadingUserIdsAsyncWithHttpInfo()  : PromiseInterface
Operation createAudienceForUploadingUserIdsAsyncWithHttpInfo
createAudienceForUploadingUserIdsRequest()  : Request
Create request for operation 'createAudienceForUploadingUserIds'
createAudienceForUploadingUserIdsWithHttpInfo()  : array<string|int, mixed>
Operation createAudienceForUploadingUserIdsWithHttpInfo
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
setHostIndex()  : void
Set the host index
createHttpClientOption()  : array<string|int, mixed>
Create http client option
getHostSettingsForaddUserIdsToAudience()  : array<string|int, mixed>
Returns an array of host settings for Operation addUserIdsToAudience
getHostSettingsForcreateAudienceForUploadingUserIds()  : array<string|int, mixed>
Returns an array of host settings for Operation createAudienceForUploadingUserIds

Constants

contentTypes

public array<string|int, string> contentTypes = ['addUserIdsToAudience' => ['multipart/form-data'], 'createAudienceForUploadingUserIds' => ['multipart/form-data']]

Properties

Methods

__construct()

public __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values
mixed —

addUserIdsToAudience()

Operation addUserIdsToAudience

public addUserIdsToAudience(SplFileObject $file[, int $audienceGroupId = null ][, string $uploadDescription = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['addUserIdsToAudience'][0] ]) : void

This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me

Parameters
$file : SplFileObject

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 (required)

$audienceGroupId : int = null

The audience ID. (optional)

$uploadDescription : string = null

The description to register with the job (optional)

$hostIndex : null|int = null

Host index. Defaults to null. If null, then the library will use $this->hostIndex instead

$variables : array<string|int, mixed> = []

Associative array of variables to pass to the host. Defaults to empty array.

$contentType : string = self::contentTypes['addUserIdsToAudience'][0]

The value for the Content-Type header. Check self::contentTypes['addUserIdsToAudience'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void —

addUserIdsToAudienceAsync()

Operation addUserIdsToAudienceAsync

public addUserIdsToAudienceAsync(SplFileObject $file[, int $audienceGroupId = null ][, string $uploadDescription = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['addUserIdsToAudience'][0] ]) : PromiseInterface

This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me

Parameters
$file : SplFileObject

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 (required)

$audienceGroupId : int = null

The audience ID. (optional)

$uploadDescription : string = null

The description to register with the job (optional)

$hostIndex : null|int = null

Host index. Defaults to null. If null, then the library will use $this->hostIndex instead

$variables : array<string|int, mixed> = []

Associative array of variables to pass to the host. Defaults to empty array.

$contentType : string = self::contentTypes['addUserIdsToAudience'][0]

The value for the Content-Type header. Check self::contentTypes['addUserIdsToAudience'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

addUserIdsToAudienceAsyncWithHttpInfo()

Operation addUserIdsToAudienceAsyncWithHttpInfo

public addUserIdsToAudienceAsyncWithHttpInfo(SplFileObject $file[, int $audienceGroupId = null ][, string $uploadDescription = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['addUserIdsToAudience'][0] ]) : PromiseInterface

This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me

Parameters
$file : SplFileObject

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 (required)

$audienceGroupId : int = null

The audience ID. (optional)

$uploadDescription : string = null

The description to register with the job (optional)

$hostIndex : null|int = null

Host index. Defaults to null. If null, then the library will use $this->hostIndex instead

$variables : array<string|int, mixed> = []

Associative array of variables to pass to the host. Defaults to empty array.

$contentType : string = self::contentTypes['addUserIdsToAudience'][0]

The value for the Content-Type header. Check self::contentTypes['addUserIdsToAudience'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

addUserIdsToAudienceRequest()

Create request for operation 'addUserIdsToAudience'

public addUserIdsToAudienceRequest(SplFileObject $file[, int $audienceGroupId = null ][, string $uploadDescription = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['addUserIdsToAudience'][0] ]) : Request

This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me

Parameters
$file : SplFileObject

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 (required)

$audienceGroupId : int = null

The audience ID. (optional)

$uploadDescription : string = null

The description to register with the job (optional)

$hostIndex : null|int = null

Host index. Defaults to null. If null, then the library will use $this->hostIndex instead

$variables : array<string|int, mixed> = []

Associative array of variables to pass to the host. Defaults to empty array.

$contentType : string = self::contentTypes['addUserIdsToAudience'][0]

The value for the Content-Type header. Check self::contentTypes['addUserIdsToAudience'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

addUserIdsToAudienceWithHttpInfo()

Operation addUserIdsToAudienceWithHttpInfo

public addUserIdsToAudienceWithHttpInfo(SplFileObject $file[, int $audienceGroupId = null ][, string $uploadDescription = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['addUserIdsToAudience'][0] ]) : array<string|int, mixed>

This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me

Parameters
$file : SplFileObject

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 (required)

$audienceGroupId : int = null

The audience ID. (optional)

$uploadDescription : string = null

The description to register with the job (optional)

$hostIndex : null|int = null

Host index. Defaults to null. If null, then the library will use $this->hostIndex instead

$variables : array<string|int, mixed> = []

Associative array of variables to pass to the host. Defaults to empty array.

$contentType : string = self::contentTypes['addUserIdsToAudience'][0]

The value for the Content-Type header. Check self::contentTypes['addUserIdsToAudience'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

createAudienceForUploadingUserIds()

Operation createAudienceForUploadingUserIds

public createAudienceForUploadingUserIds(SplFileObject $file[, string $description = null ][, bool $isIfaAudience = null ][, string $uploadDescription = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['createAudienceForUploadingUserIds'][0] ]) : CreateAudienceGroupResponse

This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me

Parameters
$file : SplFileObject

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 (required)

$description : string = null

The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 (optional)

$isIfaAudience : bool = null

To specify recipients by IFAs: set `true`. To specify recipients by user IDs: set `false` or omit isIfaAudience property. (optional)

$uploadDescription : string = null

The description to register for the job (in `jobs[].description`). (optional)

$hostIndex : null|int = null

Host index. Defaults to null. If null, then the library will use $this->hostIndex instead

$variables : array<string|int, mixed> = []

Associative array of variables to pass to the host. Defaults to empty array.

$contentType : string = self::contentTypes['createAudienceForUploadingUserIds'][0]

The value for the Content-Type header. Check self::contentTypes['createAudienceForUploadingUserIds'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CreateAudienceGroupResponse —

createAudienceForUploadingUserIdsAsync()

Operation createAudienceForUploadingUserIdsAsync

public createAudienceForUploadingUserIdsAsync(SplFileObject $file[, string $description = null ][, bool $isIfaAudience = null ][, string $uploadDescription = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['createAudienceForUploadingUserIds'][0] ]) : PromiseInterface

This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me

Parameters
$file : SplFileObject

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 (required)

$description : string = null

The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 (optional)

$isIfaAudience : bool = null

To specify recipients by IFAs: set `true`. To specify recipients by user IDs: set `false` or omit isIfaAudience property. (optional)

$uploadDescription : string = null

The description to register for the job (in `jobs[].description`). (optional)

$hostIndex : null|int = null

Host index. Defaults to null. If null, then the library will use $this->hostIndex instead

$variables : array<string|int, mixed> = []

Associative array of variables to pass to the host. Defaults to empty array.

$contentType : string = self::contentTypes['createAudienceForUploadingUserIds'][0]

The value for the Content-Type header. Check self::contentTypes['createAudienceForUploadingUserIds'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createAudienceForUploadingUserIdsAsyncWithHttpInfo()

Operation createAudienceForUploadingUserIdsAsyncWithHttpInfo

public createAudienceForUploadingUserIdsAsyncWithHttpInfo(SplFileObject $file[, string $description = null ][, bool $isIfaAudience = null ][, string $uploadDescription = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['createAudienceForUploadingUserIds'][0] ]) : PromiseInterface

This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me

Parameters
$file : SplFileObject

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 (required)

$description : string = null

The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 (optional)

$isIfaAudience : bool = null

To specify recipients by IFAs: set `true`. To specify recipients by user IDs: set `false` or omit isIfaAudience property. (optional)

$uploadDescription : string = null

The description to register for the job (in `jobs[].description`). (optional)

$hostIndex : null|int = null

Host index. Defaults to null. If null, then the library will use $this->hostIndex instead

$variables : array<string|int, mixed> = []

Associative array of variables to pass to the host. Defaults to empty array.

$contentType : string = self::contentTypes['createAudienceForUploadingUserIds'][0]

The value for the Content-Type header. Check self::contentTypes['createAudienceForUploadingUserIds'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createAudienceForUploadingUserIdsRequest()

Create request for operation 'createAudienceForUploadingUserIds'

public createAudienceForUploadingUserIdsRequest(SplFileObject $file[, string $description = null ][, bool $isIfaAudience = null ][, string $uploadDescription = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['createAudienceForUploadingUserIds'][0] ]) : Request

This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me

Parameters
$file : SplFileObject

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 (required)

$description : string = null

The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 (optional)

$isIfaAudience : bool = null

To specify recipients by IFAs: set `true`. To specify recipients by user IDs: set `false` or omit isIfaAudience property. (optional)

$uploadDescription : string = null

The description to register for the job (in `jobs[].description`). (optional)

$hostIndex : null|int = null

Host index. Defaults to null. If null, then the library will use $this->hostIndex instead

$variables : array<string|int, mixed> = []

Associative array of variables to pass to the host. Defaults to empty array.

$contentType : string = self::contentTypes['createAudienceForUploadingUserIds'][0]

The value for the Content-Type header. Check self::contentTypes['createAudienceForUploadingUserIds'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

createAudienceForUploadingUserIdsWithHttpInfo()

Operation createAudienceForUploadingUserIdsWithHttpInfo

public createAudienceForUploadingUserIdsWithHttpInfo(SplFileObject $file[, string $description = null ][, bool $isIfaAudience = null ][, string $uploadDescription = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['createAudienceForUploadingUserIds'][0] ]) : array<string|int, mixed>

This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me

Parameters
$file : SplFileObject

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000 (required)

$description : string = null

The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 (optional)

$isIfaAudience : bool = null

To specify recipients by IFAs: set `true`. To specify recipients by user IDs: set `false` or omit isIfaAudience property. (optional)

$uploadDescription : string = null

The description to register for the job (in `jobs[].description`). (optional)

$hostIndex : null|int = null

Host index. Defaults to null. If null, then the library will use $this->hostIndex instead

$variables : array<string|int, mixed> = []

Associative array of variables to pass to the host. Defaults to empty array.

$contentType : string = self::contentTypes['createAudienceForUploadingUserIds'][0]

The value for the Content-Type header. Check self::contentTypes['createAudienceForUploadingUserIds'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \LINE\Clients\ManageAudience\Model\CreateAudienceGroupResponse, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int —

Host index

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

Return values
void —

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed> —

of http client options

getHostSettingsForaddUserIdsToAudience()

Returns an array of host settings for Operation addUserIdsToAudience

protected getHostSettingsForaddUserIdsToAudience() : array<string|int, mixed>
Return values
array<string|int, mixed> —

an array of host settings

getHostSettingsForcreateAudienceForUploadingUserIds()

Returns an array of host settings for Operation createAudienceForUploadingUserIds

protected getHostSettingsForcreateAudienceForUploadingUserIds() : array<string|int, mixed>
Return values
array<string|int, mixed> —

an array of host settings

Search results