msccommonquery

Documentation

Index

• type Client
  • func NewClient() (client *Client, err error)
  • func NewClientWithAccessKey(regionId, accessKeyId, accessKeySecret string) (client *Client, err error)
  • func NewClientWithEcsRamRole(regionId string, roleName string) (client *Client, err error)
  • func NewClientWithOptions(regionId string, config *sdk.Config, credential auth.Credential) (client *Client, err error)
  • func NewClientWithProvider(regionId string, providers ...provider.Provider) (client *Client, err error)
  • func NewClientWithRamRoleArn(regionId string, accessKeyId, accessKeySecret, roleArn, roleSessionName string) (client *Client, err error)
  • func NewClientWithRamRoleArnAndPolicy(regionId string, ...) (client *Client, err error)
  • func NewClientWithRsaKeyPair(regionId string, publicKeyId, privateKey string, sessionExpiration int) (client *Client, err error)
  • func NewClientWithStsToken(regionId, stsAccessKeyId, stsAccessKeySecret, stsToken string) (client *Client, err error)
  • func (client *Client) ListMessages(request *ListMessagesRequest) (response *ListMessagesResponse, err error)
  • func (client *Client) ListMessagesWithCallback(request *ListMessagesRequest, ...) <-chan int
  • func (client *Client) ListMessagesWithChan(request *ListMessagesRequest) (<-chan *ListMessagesResponse, <-chan error)
• type Data
• type ListMessagesRequest
  • func CreateListMessagesRequest() (request *ListMessagesRequest)
• type ListMessagesResponse
  • func CreateListMessagesResponse() (response *ListMessagesResponse)
• type Message

Types

type Client

type Client struct {
	sdk.Client
}

Client is the sdk client struct, each func corresponds to an OpenAPI

func NewClient

func NewClient() (client *Client, err error)

NewClient creates a sdk client with environment variables

func NewClientWithAccessKey

func NewClientWithAccessKey(regionId, accessKeyId, accessKeySecret string) (client *Client, err error)

NewClientWithAccessKey is a shortcut to create sdk client with accesskey usage: https://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

func NewClientWithEcsRamRole

func NewClientWithEcsRamRole(regionId string, roleName string) (client *Client, err error)

NewClientWithEcsRamRole is a shortcut to create sdk client with ecs ram role usage: https://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

func NewClientWithOptions

func NewClientWithOptions(regionId string, config *sdk.Config, credential auth.Credential) (client *Client, err error)

NewClientWithOptions creates a sdk client with regionId/sdkConfig/credential this is the common api to create a sdk client

func NewClientWithProvider

func NewClientWithProvider(regionId string, providers ...provider.Provider) (client *Client, err error)

NewClientWithProvider creates a sdk client with providers usage: https://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

func NewClientWithRamRoleArn

func NewClientWithRamRoleArn(regionId string, accessKeyId, accessKeySecret, roleArn, roleSessionName string) (client *Client, err error)

NewClientWithRamRoleArn is a shortcut to create sdk client with ram roleArn usage: https://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

func NewClientWithRamRoleArnAndPolicy

func NewClientWithRamRoleArnAndPolicy(regionId string, accessKeyId, accessKeySecret, roleArn, roleSessionName, policy string) (client *Client, err error)

NewClientWithRamRoleArn is a shortcut to create sdk client with ram roleArn and policy usage: https://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

func NewClientWithRsaKeyPair

func NewClientWithRsaKeyPair(regionId string, publicKeyId, privateKey string, sessionExpiration int) (client *Client, err error)

NewClientWithRsaKeyPair is a shortcut to create sdk client with rsa key pair usage: https://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

func NewClientWithStsToken

func NewClientWithStsToken(regionId, stsAccessKeyId, stsAccessKeySecret, stsToken string) (client *Client, err error)

NewClientWithStsToken is a shortcut to create sdk client with sts token usage: https://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

func (*Client) ListMessages

func (client *Client) ListMessages(request *ListMessagesRequest) (response *ListMessagesResponse, err error)

ListMessages invokes the msccommonquery.ListMessages API synchronously

func (*Client) ListMessagesWithCallback

func (client *Client) ListMessagesWithCallback(request *ListMessagesRequest, callback func(response *ListMessagesResponse, err error)) <-chan int

ListMessagesWithCallback invokes the msccommonquery.ListMessages API asynchronously

func (*Client) ListMessagesWithChan

func (client *Client) ListMessagesWithChan(request *ListMessagesRequest) (<-chan *ListMessagesResponse, <-chan error)

ListMessagesWithChan invokes the msccommonquery.ListMessages API asynchronously

type Data

type Data struct {
	Message []Message `json:"Message" xml:"Message"`
}

Data is a nested struct in msccommonquery response

type ListMessagesRequest

type ListMessagesRequest struct {
	*requests.RpcRequest
	StartTimestamp requests.Integer `position:"Body" name:"StartTimestamp"`
	Locale         string           `position:"Query" name:"Locale"`
	EndTimestamp   requests.Integer `position:"Body" name:"EndTimestamp"`
	PageNo         requests.Integer `position:"Body" name:"PageNo"`
	ChannelType    string           `position:"Body" name:"ChannelType"`
	PageSize       requests.Integer `position:"Body" name:"PageSize"`
}

ListMessagesRequest is the request struct for api ListMessages

func CreateListMessagesRequest

func CreateListMessagesRequest() (request *ListMessagesRequest)

CreateListMessagesRequest creates a request to invoke ListMessages API

type ListMessagesResponse

type ListMessagesResponse struct {
	*responses.BaseResponse
	RequestId string    `json:"RequestId" xml:"RequestId"`
	Code      string    `json:"Code" xml:"Code"`
	Message   string    `json:"Message" xml:"Message"`
	Success   bool      `json:"Success" xml:"Success"`
	Total     int       `json:"Total" xml:"Total"`
	Data      []Message `json:"Data" xml:"Data"`
}

ListMessagesResponse is the response struct for api ListMessages

func CreateListMessagesResponse

func CreateListMessagesResponse() (response *ListMessagesResponse)

CreateListMessagesResponse creates a response to parse from ListMessages response

type Message

type Message struct {
	MessageId   string `json:"MessageId" xml:"MessageId"`
	Receiver    string `json:"Receiver" xml:"Receiver"`
	ChannelType string `json:"ChannelType" xml:"ChannelType"`
	Title       string `json:"Title" xml:"Title"`
	Content     string `json:"Content" xml:"Content"`
	Status      string `json:"Status" xml:"Status"`
	Timestamp   int64  `json:"Timestamp" xml:"Timestamp"`
}

Message is a nested struct in msccommonquery response