admin

Documentation

Index

• type APIv1
• type APIv1Builder
  • func NewAPIv1Builder() *APIv1Builder
  • func (b *APIv1Builder) Build() (APIv1, error)
  • func (b *APIv1Builder) DisableHttpLogging() *APIv1Builder
  • func (b *APIv1Builder) SetClient(client api.Client) *APIv1Builder
  • func (b *APIv1Builder) SetDevKey(devKey string) *APIv1Builder
  • func (b *APIv1Builder) SetDevSecret(devSecret string) *APIv1Builder
  • func (b *APIv1Builder) SetHost(host string) *APIv1Builder
  • func (b *APIv1Builder) SetHttpLogLevel(httpLogLevel api.HttpLogLevel) *APIv1Builder
  • func (b *APIv1Builder) SetLogger(logger jiguang.Logger) *APIv1Builder
• type AppCreateParam
• type AppCreateResult
  • func (rs *AppCreateResult) IsSuccess() bool
• type AppDeleteResult
  • func (rs *AppDeleteResult) IsSuccess() bool
• type CertificateUploadParam
• type CertificateUploadResult
  • func (rs *CertificateUploadResult) IsSuccess() bool

Types

type APIv1

type APIv1 interface {
	// 创建极光 APP
	//  - 功能说明：在开发者账号下创建一个 APP。
	//  - 调用地址：POST `/v1/app`
	//  - 接口文档：https://docs.jiguang.cn/jpush/server/push/rest_api_admin_api_v1#%E5%88%9B%E5%BB%BA%E6%9E%81%E5%85%89-app
	CreateApp(ctx context.Context, param *AppCreateParam) (*AppCreateResult, error)

	// 删除极光 APP
	//  - 功能说明：删除开发者账号下的指定 APP。
	//  - 调用地址：POST `/v1/app/{appKey}/delete`，appKey 为 APP 的唯一标识。
	//  - 接口文档：https://docs.jiguang.cn/jpush/server/push/rest_api_admin_api_v1#app-%E5%88%A0%E9%99%A4
	DeleteApp(ctx context.Context, appKey string) (*AppDeleteResult, error)

	// 极光 APP 证书上传
	//  - 功能说明：上传开发或生产证书到对应的极光 APP。
	//  - 调用地址：POST `/v1/app/{appKey}/certificate`，appKey 为 APP 的唯一标识。
	//  - 接口文档：https://docs.jiguang.cn/jpush/server/push/rest_api_admin_api_v1#%E8%AF%81%E4%B9%A6%E4%B8%8A%E4%BC%A0
	UploadCertificate(ctx context.Context, appKey string, param *CertificateUploadParam) (*CertificateUploadResult, error)
}

Admin API v1【极光推送 > REST API > 应用管理 API】

• 功能说明：提供给开发者操作创建或删除 APP，上传证书等管理功能。
• 极光文档：https://docs.jiguang.cn/jpush/server/push/rest_api_admin_api_v1

type APIv1Builder

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

用于构建和配置 Admin API v1 访问客户端的构建器。

func NewAPIv1Builder

func NewAPIv1Builder() *APIv1Builder

func (*APIv1Builder) Build

func (b *APIv1Builder) Build() (APIv1, error)

func (*APIv1Builder) DisableHttpLogging

func (b *APIv1Builder) DisableHttpLogging() *APIv1Builder

【可选】禁用 API 的 HTTP 日志记录，即不记录 API 的 HTTP 请求和响应的日志信息。

func (*APIv1Builder) SetClient

func (b *APIv1Builder) SetClient(client api.Client) *APIv1Builder

【可选】设置 API 的客户端，用于发送 HTTP 请求，默认值为 api.DefaultClient。

func (*APIv1Builder) SetDevKey

func (b *APIv1Builder) SetDevKey(devKey string) *APIv1Builder

【必填】设置 API 的开发者标识。

func (*APIv1Builder) SetDevSecret

func (b *APIv1Builder) SetDevSecret(devSecret string) *APIv1Builder

【必填】设置 API 的开发者密钥。

func (*APIv1Builder) SetHost

func (b *APIv1Builder) SetHost(host string) *APIv1Builder

【可选】设置 API 的 Host 基础 URL，默认值为 api.HostJPushAdminV1。

func (*APIv1Builder) SetHttpLogLevel

func (b *APIv1Builder) SetHttpLogLevel(httpLogLevel api.HttpLogLevel) *APIv1Builder

【可选】设置 API 的 HTTP 日志记录级别，用于指定记录 API 的 HTTP 请求和响应的日志信息的详细程度，默认值为 api.HttpLogLevelBasic。

• 可用的级别：api.HttpLogLevelNone、api.HttpLogLevelBasic、api.HttpLogLevelHeaders、api.HttpLogLevelFull；
• 若要禁用 HTTP 日志记录，可使用 DisableHttpLogging。

func (*APIv1Builder) SetLogger

func (b *APIv1Builder) SetLogger(logger jiguang.Logger) *APIv1Builder

【可选】设置 API 的日志记录器，默认值为 api.DefaultLogger。

type AppCreateParam

type AppCreateParam struct {
	AppName     string `json:"app_name"`             // 应用名称
	PackageName string `json:"android_package"`      // 应用包名（Android）
	GroupName   string `json:"group_name,omitempty"` // 应用分组名称
}

type AppCreateResult

type AppCreateResult struct {
	*api.Response `json:"-"`
	Error         *api.CodeError `json:"error,omitempty"`
	AppKey        string         `json:"app_key,omitempty"`         // 应用标识
	PackageName   string         `json:"android_package,omitempty"` // 应用包名（Android）
	IsNewCreated  *bool          `json:"is_new_created,omitempty"`  // 是否新创建的应用
	MasterSecret  string         `json:"master_secret,omitempty"`   // 应用主密钥，用于服务器端 API 调用时与 AppKey 配合使用达到鉴权的目的
}

func (*AppCreateResult) IsSuccess

func (rs *AppCreateResult) IsSuccess() bool

type AppDeleteResult

type AppDeleteResult struct {
	*api.Response `json:"-"`
	Error         *api.CodeError `json:"error,omitempty"`
	Success       string         `json:"success,omitempty"`
}

func (*AppDeleteResult) IsSuccess

func (rs *AppDeleteResult) IsSuccess() bool

type CertificateUploadParam

type CertificateUploadParam struct {
	DevCertificatePassword string      `json:"devCertificatePassword,omitempty"` // 「开发」证书密码
	DevCertificateFile     interface{} `json:"devCertificateFile,omitempty"`     // 「开发」证书文件
	ProCertificatePassword string      `json:"proCertificatePassword,omitempty"` // 「生产」证书密码
	ProCertificateFile     interface{} `json:"proCertificateFile,omitempty"`     // 「生产」证书文件
}

type CertificateUploadResult

type CertificateUploadResult struct {
	*api.Response `json:"-"`
	Error         *api.CodeError `json:"error,omitempty"`
	Success       string         `json:"success,omitempty"`
}

func (*CertificateUploadResult) IsSuccess

func (rs *CertificateUploadResult) IsSuccess() bool