larkworkplace

package
v3.3.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 5, 2024 License: MIT Imports: 4 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessData 

type AccessData struct {
	Pv *int `json:"pv,omitempty"` // 访问次数
	Uv *int `json:"uv,omitempty"` // 访问用户数(去重)
}

type AccessDataBuilder 

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

func NewAccessDataBuilder 

func NewAccessDataBuilder() *AccessDataBuilder

func (*AccessDataBuilder) Build 

func (builder *AccessDataBuilder) Build() *AccessData

func (*AccessDataBuilder) Pv 

func (builder *AccessDataBuilder) Pv(pv int) *AccessDataBuilder

访问次数

示例值：100

func (*AccessDataBuilder) Uv 

func (builder *AccessDataBuilder) Uv(uv int) *AccessDataBuilder

访问用户数(去重)

示例值：30

type BlockAccessData 

type BlockAccessData struct {
	Date       *string     `json:"date,omitempty"`        // 时间,精确到天,格式yyyy-MM-dd
	BlockId    *string     `json:"block_id,omitempty"`    // 小组件id
	AccessData *AccessData `json:"access_data,omitempty"` // block访问数据信息。
}

type BlockAccessDataBuilder 

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

func NewBlockAccessDataBuilder 

func NewBlockAccessDataBuilder() *BlockAccessDataBuilder

func (*BlockAccessDataBuilder) AccessData 

func (builder *BlockAccessDataBuilder) AccessData(accessData *AccessData) *BlockAccessDataBuilder

block访问数据信息。

示例值：

func (*BlockAccessDataBuilder) BlockId 

func (builder *BlockAccessDataBuilder) BlockId(blockId string) *BlockAccessDataBuilder

小组件id

示例值：283438293839422334

func (*BlockAccessDataBuilder) Build 

func (builder *BlockAccessDataBuilder) Build() *BlockAccessData

func (*BlockAccessDataBuilder) Date 

func (builder *BlockAccessDataBuilder) Date(date string) *BlockAccessDataBuilder

时间,精确到天,格式yyyy-MM-dd

示例值：2023-03-12

type CustomWorkplaceAccessData 

type CustomWorkplaceAccessData struct {
	CustomWorkplaceId   *string     `json:"custom_workplace_id,omitempty"`   // 定制工作台ID
	AccessData          *AccessData `json:"access_data,omitempty"`           // 访问数据
	Date                *string     `json:"date,omitempty"`                  // 时间,精确到天,格式yyyy-MM-dd
	CustomWorkplaceName []*I18nName `json:"custom_workplace_name,omitempty"` // 定制工作台多语言名字。
}

type CustomWorkplaceAccessDataBuilder 

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

func NewCustomWorkplaceAccessDataBuilder 

func NewCustomWorkplaceAccessDataBuilder() *CustomWorkplaceAccessDataBuilder

func (*CustomWorkplaceAccessDataBuilder) AccessData 

func (builder *CustomWorkplaceAccessDataBuilder) AccessData(accessData *AccessData) *CustomWorkplaceAccessDataBuilder

访问数据

示例值：

func (*CustomWorkplaceAccessDataBuilder) Build 

func (builder *CustomWorkplaceAccessDataBuilder) Build() *CustomWorkplaceAccessData

func (*CustomWorkplaceAccessDataBuilder) CustomWorkplaceId 

func (builder *CustomWorkplaceAccessDataBuilder) CustomWorkplaceId(customWorkplaceId string) *CustomWorkplaceAccessDataBuilder

定制工作台ID

示例值：tpl_645b003aaa40001435b2ddw

func (*CustomWorkplaceAccessDataBuilder) CustomWorkplaceName 

func (builder *CustomWorkplaceAccessDataBuilder) CustomWorkplaceName(customWorkplaceName []*I18nName) *CustomWorkplaceAccessDataBuilder

定制工作台多语言名字。

示例值：

func (*CustomWorkplaceAccessDataBuilder) Date 

func (builder *CustomWorkplaceAccessDataBuilder) Date(date string) *CustomWorkplaceAccessDataBuilder

时间,精确到天,格式yyyy-MM-dd

示例值：2023-03-12

type DepartmentId added in v3.0.29 

type DepartmentId struct {
	DepartmentId     *string `json:"department_id,omitempty"`      //
	OpenDepartmentId *string `json:"open_department_id,omitempty"` //
}

type DepartmentIdBuilder added in v3.0.29 

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

func NewDepartmentIdBuilder added in v3.0.29 

func NewDepartmentIdBuilder() *DepartmentIdBuilder

func (*DepartmentIdBuilder) Build added in v3.0.29 

func (builder *DepartmentIdBuilder) Build() *DepartmentId

func (*DepartmentIdBuilder) DepartmentId added in v3.0.29 

func (builder *DepartmentIdBuilder) DepartmentId(departmentId string) *DepartmentIdBuilder

示例值：

func (*DepartmentIdBuilder) OpenDepartmentId added in v3.0.29 

func (builder *DepartmentIdBuilder) OpenDepartmentId(openDepartmentId string) *DepartmentIdBuilder

示例值：

type I18nName 

type I18nName struct {
	Language *string `json:"language,omitempty"` // ISO 639-1的语言代码。比如zh表示中文。
	Name     *string `json:"name,omitempty"`     // 名字
}

type I18nNameBuilder 

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

func NewI18nNameBuilder 

func NewI18nNameBuilder() *I18nNameBuilder

func (*I18nNameBuilder) Build 

func (builder *I18nNameBuilder) Build() *I18nName

func (*I18nNameBuilder) Language 

func (builder *I18nNameBuilder) Language(language string) *I18nNameBuilder

ISO 639-1的语言代码。比如zh表示中文。

示例值：zh

func (*I18nNameBuilder) Name 

func (builder *I18nNameBuilder) Name(name string) *I18nNameBuilder

名字

示例值：名字

type Rule 

type Rule struct {
	IsAllVisible         *bool    `json:"is_all_visible,omitempty"`         // 是否全员接收通知
	VisibleDepartmentIds []string `json:"visible_department_ids,omitempty"` // 可接收通知的部门id列表，上限为500个
}

type RuleBuilder 

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

func NewRuleBuilder 

func NewRuleBuilder() *RuleBuilder

func (*RuleBuilder) Build 

func (builder *RuleBuilder) Build() *Rule

func (*RuleBuilder) IsAllVisible 

func (builder *RuleBuilder) IsAllVisible(isAllVisible bool) *RuleBuilder

是否全员接收通知

示例值：false

func (*RuleBuilder) VisibleDepartmentIds 

func (builder *RuleBuilder) VisibleDepartmentIds(visibleDepartmentIds []string) *RuleBuilder

可接收通知的部门id列表，上限为500个

示例值：["a3ed9ece96ff2b1a","a3ed9ece96ff2b1b"]

type SearchCustomWorkplaceAccessDataReq 

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

type SearchCustomWorkplaceAccessDataReqBuilder 

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

func NewSearchCustomWorkplaceAccessDataReqBuilder 

func NewSearchCustomWorkplaceAccessDataReqBuilder() *SearchCustomWorkplaceAccessDataReqBuilder

func (*SearchCustomWorkplaceAccessDataReqBuilder) Build 

func (builder *SearchCustomWorkplaceAccessDataReqBuilder) Build() *SearchCustomWorkplaceAccessDataReq

func (*SearchCustomWorkplaceAccessDataReqBuilder) CustomWorkplaceId 

func (builder *SearchCustomWorkplaceAccessDataReqBuilder) CustomWorkplaceId(customWorkplaceId string) *SearchCustomWorkplaceAccessDataReqBuilder

定制化工作台id.非必填,不填的时候,返回所有定制化工作台数据。

示例值：tpl_647184b585400013254c4ea6

func (*SearchCustomWorkplaceAccessDataReqBuilder) FromDate 

func (builder *SearchCustomWorkplaceAccessDataReqBuilder) FromDate(fromDate string) *SearchCustomWorkplaceAccessDataReqBuilder

数据检索开始时间，精确到日。格式yyyy-MM-dd

示例值：2023-03-01

func (*SearchCustomWorkplaceAccessDataReqBuilder) PageSize 

func (builder *SearchCustomWorkplaceAccessDataReqBuilder) PageSize(pageSize int) *SearchCustomWorkplaceAccessDataReqBuilder

分页大小，最小为 1，最大为 200，默认为 20。

示例值：20

func (*SearchCustomWorkplaceAccessDataReqBuilder) PageToken 

func (builder *SearchCustomWorkplaceAccessDataReqBuilder) PageToken(pageToken string) *SearchCustomWorkplaceAccessDataReqBuilder

用于标记当前请求的分页标记，将返回以当前分页标记开始，往后 page_size 个元素。第一次访问接口的时候不需要传。

示例值：ddowkdkl9w2d

func (*SearchCustomWorkplaceAccessDataReqBuilder) ToDate 

func (builder *SearchCustomWorkplaceAccessDataReqBuilder) ToDate(toDate string) *SearchCustomWorkplaceAccessDataReqBuilder

数据检索结束时间，精确到日。格式yyyy-MM-dd。

示例值：2023-03-22

type SearchCustomWorkplaceAccessDataResp 

type SearchCustomWorkplaceAccessDataResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *SearchCustomWorkplaceAccessDataRespData `json:"data"` // 业务数据
}

func (*SearchCustomWorkplaceAccessDataResp) Success 

func (resp *SearchCustomWorkplaceAccessDataResp) Success() bool

type SearchCustomWorkplaceAccessDataRespData 

type SearchCustomWorkplaceAccessDataRespData struct {
	Items     []*CustomWorkplaceAccessData `json:"items,omitempty"`      // 定制工作台访问数据
	HasMore   *bool                        `json:"has_more,omitempty"`   // 是否还有下一页数据
	PageToken *string                      `json:"page_token,omitempty"` // 分页标记，存在下一页时返回
}

type SearchWorkplaceAccessDataReq 

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

type SearchWorkplaceAccessDataReqBuilder 

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

func NewSearchWorkplaceAccessDataReqBuilder 

func NewSearchWorkplaceAccessDataReqBuilder() *SearchWorkplaceAccessDataReqBuilder

func (*SearchWorkplaceAccessDataReqBuilder) Build 

func (builder *SearchWorkplaceAccessDataReqBuilder) Build() *SearchWorkplaceAccessDataReq

func (*SearchWorkplaceAccessDataReqBuilder) FromDate 

func (builder *SearchWorkplaceAccessDataReqBuilder) FromDate(fromDate string) *SearchWorkplaceAccessDataReqBuilder

数据检索开始时间，精确到日。格式yyyy-MM-dd

示例值：2023-03-01

func (*SearchWorkplaceAccessDataReqBuilder) PageSize 

func (builder *SearchWorkplaceAccessDataReqBuilder) PageSize(pageSize int) *SearchWorkplaceAccessDataReqBuilder

分页大小，最小为 1，最大为 200，默认为 20。

示例值：20

func (*SearchWorkplaceAccessDataReqBuilder) PageToken 

func (builder *SearchWorkplaceAccessDataReqBuilder) PageToken(pageToken string) *SearchWorkplaceAccessDataReqBuilder

用于标记当前请求的分页标记，将返回以当前分页标记开始，往后 page_size 个元素。第一次访问接口的时候不需要传。

示例值：ddowkdkl9w2d

func (*SearchWorkplaceAccessDataReqBuilder) ToDate 

func (builder *SearchWorkplaceAccessDataReqBuilder) ToDate(toDate string) *SearchWorkplaceAccessDataReqBuilder

数据检索结束时间，精确到日。格式yyyy-MM-dd。

示例值：2023-03-22

type SearchWorkplaceAccessDataResp 

type SearchWorkplaceAccessDataResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *SearchWorkplaceAccessDataRespData `json:"data"` // 业务数据
}

func (*SearchWorkplaceAccessDataResp) Success 

func (resp *SearchWorkplaceAccessDataResp) Success() bool

type SearchWorkplaceAccessDataRespData 

type SearchWorkplaceAccessDataRespData struct {
	Items     []*WorkplaceAccessData `json:"items,omitempty"`      // 工作台访问数据
	HasMore   *bool                  `json:"has_more,omitempty"`   // 是否还有下一页数据
	PageToken *string                `json:"page_token,omitempty"` // 分页标记，存在下一页时返回。
}

type SearchWorkplaceBlockAccessDataReq 

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

type SearchWorkplaceBlockAccessDataReqBuilder 

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

func NewSearchWorkplaceBlockAccessDataReqBuilder 

func NewSearchWorkplaceBlockAccessDataReqBuilder() *SearchWorkplaceBlockAccessDataReqBuilder

func (*SearchWorkplaceBlockAccessDataReqBuilder) BlockId 

func (builder *SearchWorkplaceBlockAccessDataReqBuilder) BlockId(blockId string) *SearchWorkplaceBlockAccessDataReqBuilder

小组件id

示例值：283438293839422334

func (*SearchWorkplaceBlockAccessDataReqBuilder) Build 

func (builder *SearchWorkplaceBlockAccessDataReqBuilder) Build() *SearchWorkplaceBlockAccessDataReq

func (*SearchWorkplaceBlockAccessDataReqBuilder) FromDate 

func (builder *SearchWorkplaceBlockAccessDataReqBuilder) FromDate(fromDate string) *SearchWorkplaceBlockAccessDataReqBuilder

数据检索开始时间，精确到日。格式yyyy-MM-dd。

示例值：2023-02-01

func (*SearchWorkplaceBlockAccessDataReqBuilder) PageSize 

func (builder *SearchWorkplaceBlockAccessDataReqBuilder) PageSize(pageSize int) *SearchWorkplaceBlockAccessDataReqBuilder

分页大小，最小为 1，最大为 200，默认为 20。

示例值：20

func (*SearchWorkplaceBlockAccessDataReqBuilder) PageToken 

func (builder *SearchWorkplaceBlockAccessDataReqBuilder) PageToken(pageToken string) *SearchWorkplaceBlockAccessDataReqBuilder

用于标记当前请求的分页标记，将返回以当前分页标记开始，往后 page_size 个元素。第一次访问接口的时候不需要传。

示例值：ddowkdkl9w2d

func (*SearchWorkplaceBlockAccessDataReqBuilder) ToDate 

func (builder *SearchWorkplaceBlockAccessDataReqBuilder) ToDate(toDate string) *SearchWorkplaceBlockAccessDataReqBuilder

数据检索结束时间，精确到日。格式yyyy-MM-dd。

示例值：2023-03-02

type SearchWorkplaceBlockAccessDataResp 

type SearchWorkplaceBlockAccessDataResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *SearchWorkplaceBlockAccessDataRespData `json:"data"` // 业务数据
}

func (*SearchWorkplaceBlockAccessDataResp) Success 

func (resp *SearchWorkplaceBlockAccessDataResp) Success() bool

type SearchWorkplaceBlockAccessDataRespData 

type SearchWorkplaceBlockAccessDataRespData struct {
	Items     []*BlockAccessData `json:"items,omitempty"`      // 工作台中block的访问数据
	HasMore   *bool              `json:"has_more,omitempty"`   // 是否还有下一页数据
	PageToken *string            `json:"page_token,omitempty"` // 分页标记，存在下一页时返回
}

type TemplateWorkplaceAccessData 

type TemplateWorkplaceAccessData struct {
	TplId      *string     `json:"tpl_id,omitempty"`      // 定制工作台ID
	AccessData *AccessData `json:"access_data,omitempty"` // 访问数据
}

type TemplateWorkplaceAccessDataBuilder 

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

func NewTemplateWorkplaceAccessDataBuilder 

func NewTemplateWorkplaceAccessDataBuilder() *TemplateWorkplaceAccessDataBuilder

func (*TemplateWorkplaceAccessDataBuilder) AccessData 

func (builder *TemplateWorkplaceAccessDataBuilder) AccessData(accessData *AccessData) *TemplateWorkplaceAccessDataBuilder

访问数据

示例值：

func (*TemplateWorkplaceAccessDataBuilder) Build 

func (builder *TemplateWorkplaceAccessDataBuilder) Build() *TemplateWorkplaceAccessData

func (*TemplateWorkplaceAccessDataBuilder) TplId 

func (builder *TemplateWorkplaceAccessDataBuilder) TplId(tplId string) *TemplateWorkplaceAccessDataBuilder

定制工作台ID

示例值：tpl_645b003aaa40001435b2ddw

type V1 added in v3.1.0 

type V1 struct {
	CustomWorkplaceAccessData *customWorkplaceAccessData // custom_workplace_access_data
	WorkplaceAccessData       *workplaceAccessData       // workplace_access_data
	WorkplaceBlockAccessData  *workplaceBlockAccessData  // workplace_block_access_data
}

func New added in v3.1.0 

func New(config *larkcore.Config) *V1

type WorkplaceAccessData 

type WorkplaceAccessData struct {
	Date             *string     `json:"date,omitempty"`              // 时间,精确到天,格式yyyy-MM-dd
	AllWorkplace     *AccessData `json:"all_workplace,omitempty"`     // 全部工作台的访问数据
	DefaultWorkplace *AccessData `json:"default_workplace,omitempty"` // 默认工作台的访问数据
}

type WorkplaceAccessDataBuilder 

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

func NewWorkplaceAccessDataBuilder 

func NewWorkplaceAccessDataBuilder() *WorkplaceAccessDataBuilder

func (*WorkplaceAccessDataBuilder) AllWorkplace 

func (builder *WorkplaceAccessDataBuilder) AllWorkplace(allWorkplace *AccessData) *WorkplaceAccessDataBuilder

全部工作台的访问数据

示例值：20

func (*WorkplaceAccessDataBuilder) Build 

func (builder *WorkplaceAccessDataBuilder) Build() *WorkplaceAccessData

func (*WorkplaceAccessDataBuilder) Date 

func (builder *WorkplaceAccessDataBuilder) Date(date string) *WorkplaceAccessDataBuilder

时间,精确到天,格式yyyy-MM-dd

示例值：2023-03-12

func (*WorkplaceAccessDataBuilder) DefaultWorkplace 

func (builder *WorkplaceAccessDataBuilder) DefaultWorkplace(defaultWorkplace *AccessData) *WorkplaceAccessDataBuilder

默认工作台的访问数据

示例值：10

type WorkplaceTenantNotification 

type WorkplaceTenantNotification struct {
	NotificationId *string `json:"notification_id,omitempty"` // 通知id
	Content        *string `json:"content,omitempty"`         // 通知内容 json 格式
	ExpireTime     *string `json:"expire_time,omitempty"`     // 自动过期删除的时间戳(秒)
	Rule           *Rule   `json:"rule,omitempty"`            // 配置可接收到通知的规则
}

type WorkplaceTenantNotificationBuilder 

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

func NewWorkplaceTenantNotificationBuilder 

func NewWorkplaceTenantNotificationBuilder() *WorkplaceTenantNotificationBuilder

func (*WorkplaceTenantNotificationBuilder) Build 

func (builder *WorkplaceTenantNotificationBuilder) Build() *WorkplaceTenantNotification

func (*WorkplaceTenantNotificationBuilder) Content 

func (builder *WorkplaceTenantNotificationBuilder) Content(content string) *WorkplaceTenantNotificationBuilder

通知内容 json 格式

示例值：{\"pc_notification\":{\"config\":{\"width\":500,\"height\":500},\"i18n_elements\":{\"zh_cn\":[{\"tag\":\"img\",\"url\":\"https://www.feishu.cn\",\"img_key\":\"test\"}]}}}

func (*WorkplaceTenantNotificationBuilder) ExpireTime 

func (builder *WorkplaceTenantNotificationBuilder) ExpireTime(expireTime string) *WorkplaceTenantNotificationBuilder

自动过期删除的时间戳(秒)

示例值：1739717852

func (*WorkplaceTenantNotificationBuilder) NotificationId 

func (builder *WorkplaceTenantNotificationBuilder) NotificationId(notificationId string) *WorkplaceTenantNotificationBuilder

通知id

示例值：own_xxxxxxxxxxxxxxxx

func (*WorkplaceTenantNotificationBuilder) Rule 

func (builder *WorkplaceTenantNotificationBuilder) Rule(rule *Rule) *WorkplaceTenantNotificationBuilder

配置可接收到通知的规则

示例值：

type WorkplaceUserNotification 

type WorkplaceUserNotification struct {
	NotificationId *string `json:"notification_id,omitempty"` // 通知 id
	Content        *string `json:"content,omitempty"`         // 通知内容 json 格式
	ExpireTime     *string `json:"expire_time,omitempty"`     // 自动过期删除的时间戳(秒)
}

type WorkplaceUserNotificationBuilder 

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

func NewWorkplaceUserNotificationBuilder 

func NewWorkplaceUserNotificationBuilder() *WorkplaceUserNotificationBuilder

func (*WorkplaceUserNotificationBuilder) Build 

func (builder *WorkplaceUserNotificationBuilder) Build() *WorkplaceUserNotification

func (*WorkplaceUserNotificationBuilder) Content 

func (builder *WorkplaceUserNotificationBuilder) Content(content string) *WorkplaceUserNotificationBuilder

通知内容 json 格式

示例值：{\"pc_notification\":{\"config\":{\"width\":500,\"height\":500},\"i18n_elements\":{\"zh_cn\":[{\"tag\":\"img\",\"url\":\"https://www.feishu.cn\",\"img_key\":\"test\"}]}}}

func (*WorkplaceUserNotificationBuilder) ExpireTime 

func (builder *WorkplaceUserNotificationBuilder) ExpireTime(expireTime string) *WorkplaceUserNotificationBuilder

自动过期删除的时间戳(秒)

示例值：1739717852

func (*WorkplaceUserNotificationBuilder) NotificationId 

func (builder *WorkplaceUserNotificationBuilder) NotificationId(notificationId string) *WorkplaceUserNotificationBuilder

通知 id

示例值：own_xxxxxxxxxxxxxxxx

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.