link

Documentation

Overview

Package link generate short links

Index

• type GenerateLinkData
• type GenerateLinkRequest
• type GenerateLinkResponse
• type GenerateV1Request
• type GenerateV1Response
• type Link
  • func New(cfg *credential.ContextConfig) *Link
  • func (l *Link) Generate(ctx context.Context, req *GenerateV1Request) (resp *GenerateV1Response, err error)
  • func (l *Link) GenerateV2(ctx context.Context, req *GenerateLinkRequest) (resp *GenerateLinkResponse, err error)
  • func (l *Link) QueryQuotaV2(ctx context.Context, req *QueryLinkQuotaRequest) (resp *QueryLinkQuotaResponse, err error)
  • func (l *Link) QueryV2(ctx context.Context, req *QueryLinkRequest) (resp *QueryLinkResponse, err error)
• type QueryLinkData
• type QueryLinkQuotaRequest
• type QueryLinkQuotaResponse
• type QueryLinkRequest
• type QueryLinkResponse
• type URLLinkQuota

Types

type GenerateLinkData

type GenerateLinkData struct {
	URLLink string `json:"url_link"`
}

GenerateLinkData generate link data

type GenerateLinkRequest

type GenerateLinkRequest struct {
	AppID      string `json:"app_id"`
	AppName    string `json:"app_name"`
	Path       string `json:"path,omitempty"`
	Query      string `json:"query,omitempty"`
	ExpireTime int    `json:"expire_time"`
}

GenerateLinkRequest generate link request

type GenerateLinkResponse

type GenerateLinkResponse struct {
	base.CommonResponse
	Data GenerateLinkData `json:"data"`
}

GenerateLinkResponse generate link response

type GenerateV1Request

type GenerateV1Request struct {
	AccessToken string `json:"access_token"`
	MaAppID     string `json:"ma_app_id"`
	AppName     string `json:"app_name"`
	Path        string `json:"path,omitempty"`
	Query       string `json:"query,omitempty"`
	ExpireTime  int    `json:"expire_time"`
}

GenerateV1Request generate link request

type GenerateV1Response

type GenerateV1Response struct {
	ErrNo   int    `json:"err_no"`
	ErrTips string `json:"err_tips"`
	URLLink string `json:"url_link"`
}

GenerateV1Response generate link response

type Link

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

Link short link relation

func New

func New(cfg *credential.ContextConfig) *Link

New create short link

func (*Link) Generate

func (l *Link) Generate(ctx context.Context, req *GenerateV1Request) (resp *GenerateV1Response, err error)

Generate generate short link

func (*Link) GenerateV2

func (l *Link) GenerateV2(ctx context.Context, req *GenerateLinkRequest) (resp *GenerateLinkResponse, err error)

GenerateV2 generate short link v2

func (*Link) QueryQuotaV2

func (l *Link) QueryQuotaV2(ctx context.Context, req *QueryLinkQuotaRequest) (resp *QueryLinkQuotaResponse, err error)

QueryQuotaV2 query link quota v2

func (*Link) QueryV2

func (l *Link) QueryV2(ctx context.Context, req *QueryLinkRequest) (resp *QueryLinkResponse, err error)

QueryV2 query link v2

type QueryLinkData

type QueryLinkData struct {
	AppName    string `json:"app_name"`
	AppID      string `json:"app_id"`
	Path       string `json:"path"`
	Query      string `json:"query"`
	CreateTime int    `json:"create_time"`
	ExpireTime int    `json:"expire_time"`
}

QueryLinkData query link data

type QueryLinkQuotaRequest

type QueryLinkQuotaRequest struct {
	AppID string `json:"app_id"`
}

QueryLinkQuotaRequest query link quota request

type QueryLinkQuotaResponse

type QueryLinkQuotaResponse struct {
	base.CommonResponse
	URLLinkQuota URLLinkQuota `json:"url_link_quota"`
}

QueryLinkQuotaResponse query link quota response

type QueryLinkRequest

type QueryLinkRequest struct {
	AppID   string `json:"app_id"`
	URLLink string `json:"url_link"`
}

QueryLinkRequest query link request

type QueryLinkResponse

type QueryLinkResponse struct {
	base.CommonResponse
	Data QueryLinkData `json:"data"`
}

QueryLinkResponse query link response

type URLLinkQuota

type URLLinkQuota struct {
	URLLinkUsed  int `json:"url_link_used"`
	URLLinkLimit int `json:"url_link_limit"`
}

URLLinkQuota url link quota