module

Documentation

Index

• type AcquireChatControlRequest
• type DetachModuleRequest
• type GetModulesResponse
• type LineModuleAPI
  • func NewLineModuleAPI(channelToken string, options ...LineModuleAPIOption) (*LineModuleAPI, error)
  • func (client *LineModuleAPI) AcquireChatControl(chatId string, acquireChatControlRequest *AcquireChatControlRequest) (struct{}, error)
  • func (client *LineModuleAPI) AcquireChatControlWithHttpInfo(chatId string, acquireChatControlRequest *AcquireChatControlRequest) (*http.Response, struct{}, error)
  • func (client *LineModuleAPI) DetachModule(detachModuleRequest *DetachModuleRequest) (struct{}, error)
  • func (client *LineModuleAPI) DetachModuleWithHttpInfo(detachModuleRequest *DetachModuleRequest) (*http.Response, struct{}, error)
  • func (client *LineModuleAPI) Do(req *http.Request) (*http.Response, error)
  • func (client *LineModuleAPI) GetModules(start string, limit int32) (*GetModulesResponse, error)
  • func (client *LineModuleAPI) GetModulesWithHttpInfo(start string, limit int32) (*http.Response, *GetModulesResponse, error)
  • func (client *LineModuleAPI) ReleaseChatControl(chatId string) (struct{}, error)
  • func (client *LineModuleAPI) ReleaseChatControlWithHttpInfo(chatId string) (*http.Response, struct{}, error)
  • func (client *LineModuleAPI) Url(endpointPath string) string
  • func (call *LineModuleAPI) WithContext(ctx context.Context) *LineModuleAPI
• type LineModuleAPIOption
  • func WithEndpoint(endpoint string) LineModuleAPIOption
  • func WithHTTPClient(c *http.Client) LineModuleAPIOption
• type ModuleBot

Types

type AcquireChatControlRequest

type AcquireChatControlRequest struct {

	/**
	 * `True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There's no time limit and the initiative (Chat Control) doesn't change over time.
	 */
	Expired bool `json:"expired"`

	/**
	 * The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour).  * Ignored if the value of expired is false.
	 * maximum: 31536000
	 */
	Ttl int32 `json:"ttl"`
}

AcquireChatControlRequest Request entity of the Acquire Control API https://developers.line.biz/en/reference/partner-docs/#acquire-control-api

type DetachModuleRequest

type DetachModuleRequest struct {

	/**
	 * User ID of the LINE Official Account bot attached to the module channel.
	 */
	BotId string `json:"botId,omitempty"`
}

DetachModuleRequest Unlink (detach) the module channel by the operation of the module channel administrator https://developers.line.biz/en/reference/partner-docs/#unlink-detach-module-channel-by-operation-mc-admin

type GetModulesResponse

type GetModulesResponse struct {

	/**
	 * Array of Bot list Item objects representing basic information about the bot. (Required)
	 */
	Bots []ModuleBot `json:"bots"`

	/**
	 * Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results.
	 */
	Next string `json:"next,omitempty"`
}

GetModulesResponse List of bots to which the module is attached https://developers.line.biz/en/reference/partner-docs/#get-multiple-bot-info-api

type LineModuleAPI

type LineModuleAPI struct {
	// contains filtered or unexported fields
}

func NewLineModuleAPI

func NewLineModuleAPI(channelToken string, options ...LineModuleAPIOption) (*LineModuleAPI, error)

New returns a new bot client instance.

func (*LineModuleAPI) AcquireChatControl

func (client *LineModuleAPI) AcquireChatControl(

	chatId string,

	acquireChatControlRequest *AcquireChatControlRequest,

) (struct{}, error)

https://developers.line.biz/en/reference/partner-docs/#acquire-control-api

func (*LineModuleAPI) AcquireChatControlWithHttpInfo

func (client *LineModuleAPI) AcquireChatControlWithHttpInfo(

	chatId string,

	acquireChatControlRequest *AcquireChatControlRequest,

) (*http.Response, struct{}, error)

https://developers.line.biz/en/reference/partner-docs/#acquire-control-api

func (*LineModuleAPI) DetachModule

func (client *LineModuleAPI) DetachModule(

	detachModuleRequest *DetachModuleRequest,

) (struct{}, error)

https://developers.line.biz/en/reference/partner-docs/#unlink-detach-module-channel-by-operation-mc-admin

func (*LineModuleAPI) DetachModuleWithHttpInfo

func (client *LineModuleAPI) DetachModuleWithHttpInfo(

	detachModuleRequest *DetachModuleRequest,

) (*http.Response, struct{}, error)

https://developers.line.biz/en/reference/partner-docs/#unlink-detach-module-channel-by-operation-mc-admin

func (*LineModuleAPI) Do

func (client *LineModuleAPI) Do(req *http.Request) (*http.Response, error)

func (*LineModuleAPI) GetModules

func (client *LineModuleAPI) GetModules(

	start string,

	limit int32,

) (*GetModulesResponse, error)

https://developers.line.biz/en/reference/partner-docs/#get-multiple-bot-info-api

func (*LineModuleAPI) GetModulesWithHttpInfo

func (client *LineModuleAPI) GetModulesWithHttpInfo(

	start string,

	limit int32,

) (*http.Response, *GetModulesResponse, error)

https://developers.line.biz/en/reference/partner-docs/#get-multiple-bot-info-api

func (*LineModuleAPI) ReleaseChatControl

func (client *LineModuleAPI) ReleaseChatControl(

	chatId string,

) (struct{}, error)

https://developers.line.biz/en/reference/partner-docs/#release-control-api

func (*LineModuleAPI) ReleaseChatControlWithHttpInfo

func (client *LineModuleAPI) ReleaseChatControlWithHttpInfo(

	chatId string,

) (*http.Response, struct{}, error)

https://developers.line.biz/en/reference/partner-docs/#release-control-api

func (*LineModuleAPI) Url

func (client *LineModuleAPI) Url(endpointPath string) string

func (*LineModuleAPI) WithContext

func (call *LineModuleAPI) WithContext(ctx context.Context) *LineModuleAPI

WithContext method

type LineModuleAPIOption

type LineModuleAPIOption func(*LineModuleAPI) error

LineModuleAPIOption type

func WithEndpoint

func WithEndpoint(endpoint string) LineModuleAPIOption

WithEndpoint function

func WithHTTPClient

func WithHTTPClient(c *http.Client) LineModuleAPIOption

WithHTTPClient function

type ModuleBot

type ModuleBot struct {

	/**
	 * Bot's user ID (Required)
	 */
	UserId string `json:"userId"`

	/**
	 * Bot's basic ID (Required)
	 */
	BasicId string `json:"basicId"`

	/**
	 * Bot's premium ID. Not included in the response if the premium ID isn't set.
	 */
	PremiumId string `json:"premiumId,omitempty"`

	/**
	 * Bot's display name (Required)
	 */
	DisplayName string `json:"displayName"`

	/**
	 * Profile image URL. Image URL starting with `https://`. Not included in the response if the bot doesn't have a profile image.
	 */
	PictureUrl string `json:"pictureUrl,omitempty"`
}

ModuleBot basic information about the bot. https://developers.line.biz/en/reference/partner-docs/#get-multiple-bot-info-api