larkdocx

package
v3.0.3 Latest Latest
Warning

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

Go to latest
Published: Sep 7, 2022 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const (
	LangZH = 0 // 中文
	LangEN = 1 // 英文
	LangJP = 2 // 日文

)
View Source
const (
	UserIdTypeUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UserIdTypeGetDocumentBlockUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeGetDocumentBlockUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeGetDocumentBlockOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UserIdTypeListDocumentBlockUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeListDocumentBlockUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeListDocumentBlockOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UserIdTypePatchDocumentBlockUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypePatchDocumentBlockUnionId = "union_id" // 以union_id来识别用户
	UserIdTypePatchDocumentBlockOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UserIdTypeCreateDocumentBlockChildrenUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeCreateDocumentBlockChildrenUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeCreateDocumentBlockChildrenOpenId  = "open_id"  // 以open_id来识别用户
)
View Source
const (
	UserIdTypeGetDocumentBlockChildrenUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeGetDocumentBlockChildrenUnionId = "union_id" // 以union_id来识别用户
	UserIdTypeGetDocumentBlockChildrenOpenId  = "open_id"  // 以open_id来识别用户
)

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchDeleteDocumentBlockChildrenPathReqBodyBuilder

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

func NewBatchDeleteDocumentBlockChildrenPathReqBodyBuilder

func NewBatchDeleteDocumentBlockChildrenPathReqBodyBuilder() *BatchDeleteDocumentBlockChildrenPathReqBodyBuilder

func (*BatchDeleteDocumentBlockChildrenPathReqBodyBuilder) Build

func (*BatchDeleteDocumentBlockChildrenPathReqBodyBuilder) EndIndex

删除的末尾索引(操作区间左闭右开)

示例值:1

func (*BatchDeleteDocumentBlockChildrenPathReqBodyBuilder) StartIndex

删除的起始索引(操作区间左闭右开)

示例值:0

type BatchDeleteDocumentBlockChildrenReq

type BatchDeleteDocumentBlockChildrenReq struct {
	Body *BatchDeleteDocumentBlockChildrenReqBody `body:""`
	// contains filtered or unexported fields
}

type BatchDeleteDocumentBlockChildrenReqBody

type BatchDeleteDocumentBlockChildrenReqBody struct {
	StartIndex *int `json:"start_index,omitempty"` // 删除的起始索引(操作区间左闭右开)
	EndIndex   *int `json:"end_index,omitempty"`   // 删除的末尾索引(操作区间左闭右开)
}

type BatchDeleteDocumentBlockChildrenReqBodyBuilder

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

func NewBatchDeleteDocumentBlockChildrenReqBodyBuilder

func NewBatchDeleteDocumentBlockChildrenReqBodyBuilder() *BatchDeleteDocumentBlockChildrenReqBodyBuilder

func (*BatchDeleteDocumentBlockChildrenReqBodyBuilder) Build

func (*BatchDeleteDocumentBlockChildrenReqBodyBuilder) EndIndex

删除的末尾索引(操作区间左闭右开)

示例值:1

func (*BatchDeleteDocumentBlockChildrenReqBodyBuilder) StartIndex

删除的起始索引(操作区间左闭右开)

示例值:0

type BatchDeleteDocumentBlockChildrenReqBuilder

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

func NewBatchDeleteDocumentBlockChildrenReqBuilder

func NewBatchDeleteDocumentBlockChildrenReqBuilder() *BatchDeleteDocumentBlockChildrenReqBuilder

func (*BatchDeleteDocumentBlockChildrenReqBuilder) BlockId

父 Block 的唯一标识

示例值:doxcnO6UW6wAw2qIcYf4hZpFIth

func (*BatchDeleteDocumentBlockChildrenReqBuilder) Body

指定需要操作的块,删除其指定范围的子块。如果操作成功,接口将返回应用删除操作后的文档版本号。

func (*BatchDeleteDocumentBlockChildrenReqBuilder) Build

func (*BatchDeleteDocumentBlockChildrenReqBuilder) ClientToken

操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。

示例值:fe599b60-450f-46ff-b2ef-9f6675625b97

func (*BatchDeleteDocumentBlockChildrenReqBuilder) DocumentId

文档的唯一标识

示例值:doxcnePuYufKa49ISjhD8Ih0ikh

func (*BatchDeleteDocumentBlockChildrenReqBuilder) DocumentRevisionId

func (builder *BatchDeleteDocumentBlockChildrenReqBuilder) DocumentRevisionId(documentRevisionId int) *BatchDeleteDocumentBlockChildrenReqBuilder

操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限。

示例值:-1

type BatchDeleteDocumentBlockChildrenResp

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

func (*BatchDeleteDocumentBlockChildrenResp) Success

type BatchDeleteDocumentBlockChildrenRespData

type BatchDeleteDocumentBlockChildrenRespData struct {
	DocumentRevisionId *int    `json:"document_revision_id,omitempty"` // 当前删除操作成功后文档的版本号
	ClientToken        *string `json:"client_token,omitempty"`         // 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新
}

type BatchUpdateDocumentBlockPathReqBodyBuilder

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

func NewBatchUpdateDocumentBlockPathReqBodyBuilder

func NewBatchUpdateDocumentBlockPathReqBodyBuilder() *BatchUpdateDocumentBlockPathReqBodyBuilder

func (*BatchUpdateDocumentBlockPathReqBodyBuilder) Build

func (*BatchUpdateDocumentBlockPathReqBodyBuilder) Requests

批量更新 Block

示例值:

type BatchUpdateDocumentBlockReq

type BatchUpdateDocumentBlockReq struct {
	Body *BatchUpdateDocumentBlockReqBody `body:""`
	// contains filtered or unexported fields
}

type BatchUpdateDocumentBlockReqBody

type BatchUpdateDocumentBlockReqBody struct {
	Requests []*UpdateBlockRequest `json:"requests,omitempty"` // 批量更新 Block
}

type BatchUpdateDocumentBlockReqBodyBuilder

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

func NewBatchUpdateDocumentBlockReqBodyBuilder

func NewBatchUpdateDocumentBlockReqBodyBuilder() *BatchUpdateDocumentBlockReqBodyBuilder

func (*BatchUpdateDocumentBlockReqBodyBuilder) Build

func (*BatchUpdateDocumentBlockReqBodyBuilder) Requests

批量更新 Block

示例值:

type BatchUpdateDocumentBlockReqBuilder

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

func NewBatchUpdateDocumentBlockReqBuilder

func NewBatchUpdateDocumentBlockReqBuilder() *BatchUpdateDocumentBlockReqBuilder

func (*BatchUpdateDocumentBlockReqBuilder) Body

批量更新块的富文本内容。

func (*BatchUpdateDocumentBlockReqBuilder) Build

func (*BatchUpdateDocumentBlockReqBuilder) ClientToken

操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。

示例值:0e2633a3-aa1a-4171-af9e-0768ff863566

func (*BatchUpdateDocumentBlockReqBuilder) DocumentId

文档的唯一标识

示例值:doxcnePuYufKa49ISjhD8Ih0ikh

func (*BatchUpdateDocumentBlockReqBuilder) DocumentRevisionId

func (builder *BatchUpdateDocumentBlockReqBuilder) DocumentRevisionId(documentRevisionId int) *BatchUpdateDocumentBlockReqBuilder

操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限。

示例值:-1

func (*BatchUpdateDocumentBlockReqBuilder) UserIdType

此次调用中使用的用户ID的类型

示例值:

type BatchUpdateDocumentBlockResp

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

func (*BatchUpdateDocumentBlockResp) Success

func (resp *BatchUpdateDocumentBlockResp) Success() bool

type BatchUpdateDocumentBlockRespData

type BatchUpdateDocumentBlockRespData struct {
	Blocks             []*Block `json:"blocks,omitempty"`               // 批量更新的 Block
	DocumentRevisionId *int     `json:"document_revision_id,omitempty"` // 当前更新成功后文档的版本号
	ClientToken        *string  `json:"client_token,omitempty"`         // 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新
}

type Bitable

type Bitable struct {
	Token    *string `json:"token,omitempty"`     // 多维表格文档 Token
	ViewType *int    `json:"view_type,omitempty"` // 类型
}

type BitableBuilder

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

func NewBitableBuilder

func NewBitableBuilder() *BitableBuilder

func (*BitableBuilder) Build

func (builder *BitableBuilder) Build() *Bitable

func (*BitableBuilder) Token

func (builder *BitableBuilder) Token(token string) *BitableBuilder

多维表格文档 Token

示例值:basbcqH9FfRn3sWCCBOtdNVpCsb_tblSAh8fEwhuMXQg

func (*BitableBuilder) ViewType

func (builder *BitableBuilder) ViewType(viewType int) *BitableBuilder

类型

示例值:1

type Block

type Block struct {
	BlockId        *string         `json:"block_id,omitempty"`        // Block 唯一标识
	ParentId       *string         `json:"parent_id,omitempty"`       // block 的父亲 id
	Children       []string        `json:"children,omitempty"`        // block 的孩子 id 列表
	BlockType      *int            `json:"block_type,omitempty"`      // block 类型
	Page           *Text           `json:"page,omitempty"`            // 文档 Block
	Text           *Text           `json:"text,omitempty"`            // 文本 Block
	Heading1       *Text           `json:"heading1,omitempty"`        // 一级标题 Block
	Heading2       *Text           `json:"heading2,omitempty"`        // 二级标题 Block
	Heading3       *Text           `json:"heading3,omitempty"`        // 三级标题 Block
	Heading4       *Text           `json:"heading4,omitempty"`        // 四级标题 Block
	Heading5       *Text           `json:"heading5,omitempty"`        // 五级标题 Block
	Heading6       *Text           `json:"heading6,omitempty"`        // 六级标题 Block
	Heading7       *Text           `json:"heading7,omitempty"`        // 七级标题 Block
	Heading8       *Text           `json:"heading8,omitempty"`        // 八级标题 Block
	Heading9       *Text           `json:"heading9,omitempty"`        // 九级标题 Block
	Bullet         *Text           `json:"bullet,omitempty"`          // 无序列表 Block
	Ordered        *Text           `json:"ordered,omitempty"`         // 有序列表 Block
	Code           *Text           `json:"code,omitempty"`            // 代码块 Block
	Quote          *Text           `json:"quote,omitempty"`           // 引用 Block
	Equation       *Text           `json:"equation,omitempty"`        // 公式 Block
	Todo           *Text           `json:"todo,omitempty"`            // 任务 Block
	Bitable        *Bitable        `json:"bitable,omitempty"`         // 多维表格 Block
	Callout        *Callout        `json:"callout,omitempty"`         // 高亮块 Block
	ChatCard       *ChatCard       `json:"chat_card,omitempty"`       // 群聊卡片 Block
	Diagram        *Diagram        `json:"diagram,omitempty"`         // 流程图/UML Block
	Divider        *Divider        `json:"divider,omitempty"`         // 分割线 Block
	File           *File           `json:"file,omitempty"`            // 文件 Block
	Grid           *Grid           `json:"grid,omitempty"`            // 分栏 Block
	GridColumn     *GridColumn     `json:"grid_column,omitempty"`     // 分栏列 Block
	Iframe         *Iframe         `json:"iframe,omitempty"`          // 内嵌 Block
	Image          *Image          `json:"image,omitempty"`           // 图片 Block
	Isv            *Isv            `json:"isv,omitempty"`             // 三方 Block
	Mindnote       *Mindnote       `json:"mindnote,omitempty"`        // 思维笔记 Block
	Sheet          *Sheet          `json:"sheet,omitempty"`           // 电子表格 Block
	Table          *Table          `json:"table,omitempty"`           // 表格 Block
	TableCell      *TableCell      `json:"table_cell,omitempty"`      // 单元格 Block
	View           *View           `json:"view,omitempty"`            // 视图 Block
	Undefined      *Undefined      `json:"undefined,omitempty"`       // 未支持 Block
	QuoteContainer *QuoteContainer `json:"quote_container,omitempty"` // 引用容器 Block
	Task           *Task           `json:"task,omitempty"`            // 任务 Block
	Okr            *Okr            `json:"okr,omitempty"`             // OKR Block
	OkrObjective   *OkrObjective   `json:"okr_objective,omitempty"`   // OKR Objective
	OkrKeyResult   *OkrKeyResult   `json:"okr_key_result,omitempty"`  // OKR Key Result
	OkrProgress    *OkrProgress    `json:"okr_progress,omitempty"`    // OKR 进展信息
}

type BlockBuilder

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

func NewBlockBuilder

func NewBlockBuilder() *BlockBuilder

func (*BlockBuilder) Bitable

func (builder *BlockBuilder) Bitable(bitable *Bitable) *BlockBuilder

多维表格 Block

示例值:

func (*BlockBuilder) BlockId

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

Block 唯一标识

示例值:doxcnSS4ouQkQEouGSUkTg9NJPe

func (*BlockBuilder) BlockType

func (builder *BlockBuilder) BlockType(blockType int) *BlockBuilder

block 类型

示例值:1

func (*BlockBuilder) Build

func (builder *BlockBuilder) Build() *Block

func (*BlockBuilder) Bullet

func (builder *BlockBuilder) Bullet(bullet *Text) *BlockBuilder

无序列表 Block

示例值:

func (*BlockBuilder) Callout

func (builder *BlockBuilder) Callout(callout *Callout) *BlockBuilder

高亮块 Block

示例值:

func (*BlockBuilder) ChatCard

func (builder *BlockBuilder) ChatCard(chatCard *ChatCard) *BlockBuilder

群聊卡片 Block

示例值:

func (*BlockBuilder) Children

func (builder *BlockBuilder) Children(children []string) *BlockBuilder

block 的孩子 id 列表

示例值:[doxcnO6UW6wAw2qIcYf4hZpFIth]

func (*BlockBuilder) Code

func (builder *BlockBuilder) Code(code *Text) *BlockBuilder

代码块 Block

示例值:

func (*BlockBuilder) Diagram

func (builder *BlockBuilder) Diagram(diagram *Diagram) *BlockBuilder

流程图/UML Block

示例值:

func (*BlockBuilder) Divider

func (builder *BlockBuilder) Divider(divider *Divider) *BlockBuilder

分割线 Block

示例值:

func (*BlockBuilder) Equation

func (builder *BlockBuilder) Equation(equation *Text) *BlockBuilder

公式 Block

示例值:

func (*BlockBuilder) File

func (builder *BlockBuilder) File(file *File) *BlockBuilder

文件 Block

示例值:

func (*BlockBuilder) Grid

func (builder *BlockBuilder) Grid(grid *Grid) *BlockBuilder

分栏 Block

示例值:

func (*BlockBuilder) GridColumn

func (builder *BlockBuilder) GridColumn(gridColumn *GridColumn) *BlockBuilder

分栏列 Block

示例值:

func (*BlockBuilder) Heading1

func (builder *BlockBuilder) Heading1(heading1 *Text) *BlockBuilder

一级标题 Block

示例值:

func (*BlockBuilder) Heading2

func (builder *BlockBuilder) Heading2(heading2 *Text) *BlockBuilder

二级标题 Block

示例值:

func (*BlockBuilder) Heading3

func (builder *BlockBuilder) Heading3(heading3 *Text) *BlockBuilder

三级标题 Block

示例值:

func (*BlockBuilder) Heading4

func (builder *BlockBuilder) Heading4(heading4 *Text) *BlockBuilder

四级标题 Block

示例值:

func (*BlockBuilder) Heading5

func (builder *BlockBuilder) Heading5(heading5 *Text) *BlockBuilder

五级标题 Block

示例值:

func (*BlockBuilder) Heading6

func (builder *BlockBuilder) Heading6(heading6 *Text) *BlockBuilder

六级标题 Block

示例值:

func (*BlockBuilder) Heading7

func (builder *BlockBuilder) Heading7(heading7 *Text) *BlockBuilder

七级标题 Block

示例值:

func (*BlockBuilder) Heading8

func (builder *BlockBuilder) Heading8(heading8 *Text) *BlockBuilder

八级标题 Block

示例值:

func (*BlockBuilder) Heading9

func (builder *BlockBuilder) Heading9(heading9 *Text) *BlockBuilder

九级标题 Block

示例值:

func (*BlockBuilder) Iframe

func (builder *BlockBuilder) Iframe(iframe *Iframe) *BlockBuilder

内嵌 Block

示例值:

func (*BlockBuilder) Image

func (builder *BlockBuilder) Image(image *Image) *BlockBuilder

图片 Block

示例值:

func (*BlockBuilder) Isv

func (builder *BlockBuilder) Isv(isv *Isv) *BlockBuilder

三方 Block

示例值:

func (*BlockBuilder) Mindnote

func (builder *BlockBuilder) Mindnote(mindnote *Mindnote) *BlockBuilder

思维笔记 Block

示例值:

func (*BlockBuilder) Okr

func (builder *BlockBuilder) Okr(okr *Okr) *BlockBuilder

OKR Block

示例值:

func (*BlockBuilder) OkrKeyResult

func (builder *BlockBuilder) OkrKeyResult(okrKeyResult *OkrKeyResult) *BlockBuilder

OKR Key Result

示例值:

func (*BlockBuilder) OkrObjective

func (builder *BlockBuilder) OkrObjective(okrObjective *OkrObjective) *BlockBuilder

OKR Objective

示例值:

func (*BlockBuilder) OkrProgress

func (builder *BlockBuilder) OkrProgress(okrProgress *OkrProgress) *BlockBuilder

OKR 进展信息

示例值:

func (*BlockBuilder) Ordered

func (builder *BlockBuilder) Ordered(ordered *Text) *BlockBuilder

有序列表 Block

示例值:

func (*BlockBuilder) Page

func (builder *BlockBuilder) Page(page *Text) *BlockBuilder

文档 Block

示例值:

func (*BlockBuilder) ParentId

func (builder *BlockBuilder) ParentId(parentId string) *BlockBuilder

block 的父亲 id

示例值:doxcnePuYufKa49ISjhD8Ih0ikh

func (*BlockBuilder) Quote

func (builder *BlockBuilder) Quote(quote *Text) *BlockBuilder

引用 Block

示例值:

func (*BlockBuilder) QuoteContainer

func (builder *BlockBuilder) QuoteContainer(quoteContainer *QuoteContainer) *BlockBuilder

引用容器 Block

示例值:

func (*BlockBuilder) Sheet

func (builder *BlockBuilder) Sheet(sheet *Sheet) *BlockBuilder

电子表格 Block

示例值:

func (*BlockBuilder) Table

func (builder *BlockBuilder) Table(table *Table) *BlockBuilder

表格 Block

示例值:

func (*BlockBuilder) TableCell

func (builder *BlockBuilder) TableCell(tableCell *TableCell) *BlockBuilder

单元格 Block

示例值:

func (*BlockBuilder) Task

func (builder *BlockBuilder) Task(task *Task) *BlockBuilder

任务 Block

示例值:

func (*BlockBuilder) Text

func (builder *BlockBuilder) Text(text *Text) *BlockBuilder

文本 Block

示例值:

func (*BlockBuilder) Todo

func (builder *BlockBuilder) Todo(todo *Text) *BlockBuilder

任务 Block

示例值:

func (*BlockBuilder) Undefined

func (builder *BlockBuilder) Undefined(undefined *Undefined) *BlockBuilder

未支持 Block

示例值:

func (*BlockBuilder) View

func (builder *BlockBuilder) View(view *View) *BlockBuilder

视图 Block

示例值:

type Callout

type Callout struct {
	BackgroundColor *int    `json:"background_color,omitempty"` // 高亮块背景色
	BorderColor     *int    `json:"border_color,omitempty"`     // 边框色
	TextColor       *int    `json:"text_color,omitempty"`       // 文字颜色
	EmojiId         *string `json:"emoji_id,omitempty"`         // 高亮块图标
}

type CalloutBuilder

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

func NewCalloutBuilder

func NewCalloutBuilder() *CalloutBuilder

func (*CalloutBuilder) BackgroundColor

func (builder *CalloutBuilder) BackgroundColor(backgroundColor int) *CalloutBuilder

高亮块背景色

示例值:1

func (*CalloutBuilder) BorderColor

func (builder *CalloutBuilder) BorderColor(borderColor int) *CalloutBuilder

边框色

示例值:1

func (*CalloutBuilder) Build

func (builder *CalloutBuilder) Build() *Callout

func (*CalloutBuilder) EmojiId

func (builder *CalloutBuilder) EmojiId(emojiId string) *CalloutBuilder

高亮块图标

示例值:pushpin

func (*CalloutBuilder) TextColor

func (builder *CalloutBuilder) TextColor(textColor int) *CalloutBuilder

文字颜色

示例值:1

type ChatCard

type ChatCard struct {
	ChatId *string `json:"chat_id,omitempty"` // 群聊天会话 ID
	Align  *int    `json:"align,omitempty"`   // 对齐方式
}

type ChatCardBuilder

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

func NewChatCardBuilder

func NewChatCardBuilder() *ChatCardBuilder

func (*ChatCardBuilder) Align

func (builder *ChatCardBuilder) Align(align int) *ChatCardBuilder

对齐方式

示例值:1

func (*ChatCardBuilder) Build

func (builder *ChatCardBuilder) Build() *ChatCard

func (*ChatCardBuilder) ChatId

func (builder *ChatCardBuilder) ChatId(chatId string) *ChatCardBuilder

群聊天会话 ID

示例值:7052227140476993555

type CreateDocumentBlockChildrenPathReqBodyBuilder

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

func NewCreateDocumentBlockChildrenPathReqBodyBuilder

func NewCreateDocumentBlockChildrenPathReqBodyBuilder() *CreateDocumentBlockChildrenPathReqBodyBuilder

func (*CreateDocumentBlockChildrenPathReqBodyBuilder) Build

func (*CreateDocumentBlockChildrenPathReqBodyBuilder) Children

添加的孩子列表。

示例值:

func (*CreateDocumentBlockChildrenPathReqBodyBuilder) Index

当前 block 在 children 中的插入位置,起始值为 0,最大值为原 children 长度

示例值:0

type CreateDocumentBlockChildrenReq

type CreateDocumentBlockChildrenReq struct {
	Body *CreateDocumentBlockChildrenReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateDocumentBlockChildrenReqBody

type CreateDocumentBlockChildrenReqBody struct {
	Children []*Block `json:"children,omitempty"` // 添加的孩子列表。
	Index    *int     `json:"index,omitempty"`    // 当前 block 在 children 中的插入位置,起始值为 0,最大值为原 children 长度
}

type CreateDocumentBlockChildrenReqBodyBuilder

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

func NewCreateDocumentBlockChildrenReqBodyBuilder

func NewCreateDocumentBlockChildrenReqBodyBuilder() *CreateDocumentBlockChildrenReqBodyBuilder

func (*CreateDocumentBlockChildrenReqBodyBuilder) Build

func (*CreateDocumentBlockChildrenReqBodyBuilder) Children

添加的孩子列表。

示例值:

func (*CreateDocumentBlockChildrenReqBodyBuilder) Index

当前 block 在 children 中的插入位置,起始值为 0,最大值为原 children 长度

示例值:0

type CreateDocumentBlockChildrenReqBuilder

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

func NewCreateDocumentBlockChildrenReqBuilder

func NewCreateDocumentBlockChildrenReqBuilder() *CreateDocumentBlockChildrenReqBuilder

func (*CreateDocumentBlockChildrenReqBuilder) BlockId

Block 的唯一标识

示例值:doxcnO6UW6wAw2qIcYf4hZpFIth

func (*CreateDocumentBlockChildrenReqBuilder) Body

指定需要操作的块,为其创建一批子块,并插入到指定位置。如果操作成功,接口将返回新创建子块的富文本内容。

func (*CreateDocumentBlockChildrenReqBuilder) Build

func (*CreateDocumentBlockChildrenReqBuilder) ClientToken

操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。

示例值:fe599b60-450f-46ff-b2ef-9f6675625b97

func (*CreateDocumentBlockChildrenReqBuilder) DocumentId

文档的唯一标识

示例值:doxcnePuYufKa49ISjhD8Ih0ikh

func (*CreateDocumentBlockChildrenReqBuilder) DocumentRevisionId

func (builder *CreateDocumentBlockChildrenReqBuilder) DocumentRevisionId(documentRevisionId int) *CreateDocumentBlockChildrenReqBuilder

操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限。

示例值:-1

func (*CreateDocumentBlockChildrenReqBuilder) UserIdType

此次调用中使用的用户ID的类型

示例值:

type CreateDocumentBlockChildrenResp

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

func (*CreateDocumentBlockChildrenResp) Success

func (resp *CreateDocumentBlockChildrenResp) Success() bool

type CreateDocumentBlockChildrenRespData

type CreateDocumentBlockChildrenRespData struct {
	Children           []*Block `json:"children,omitempty"`             // 所添加的孩子的 Block 信息
	DocumentRevisionId *int     `json:"document_revision_id,omitempty"` // 当前 block children 创建成功后文档的版本号
	ClientToken        *string  `json:"client_token,omitempty"`         // 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新
}

type CreateDocumentPathReqBodyBuilder

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

func NewCreateDocumentPathReqBodyBuilder

func NewCreateDocumentPathReqBodyBuilder() *CreateDocumentPathReqBodyBuilder

func (*CreateDocumentPathReqBodyBuilder) Build

func (*CreateDocumentPathReqBodyBuilder) FolderToken

文件夹 token,获取方式见云文档接口快速入门;空表示根目录,tenant_access_token应用权限仅允许操作应用创建的目录

示例值:fldcnqquW1svRIYVT2Np6IuLCKd

func (*CreateDocumentPathReqBodyBuilder) Title

文档标题,只支持纯文本

示例值:undefined

type CreateDocumentReq

type CreateDocumentReq struct {
	Body *CreateDocumentReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateDocumentReqBody

type CreateDocumentReqBody struct {
	FolderToken *string `json:"folder_token,omitempty"` // 文件夹 token,获取方式见云文档接口快速入门;空表示根目录,tenant_access_token应用权限仅允许操作应用创建的目录
	Title       *string `json:"title,omitempty"`        // 文档标题,只支持纯文本
}

type CreateDocumentReqBodyBuilder

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

func NewCreateDocumentReqBodyBuilder

func NewCreateDocumentReqBodyBuilder() *CreateDocumentReqBodyBuilder

func (*CreateDocumentReqBodyBuilder) Build

func (*CreateDocumentReqBodyBuilder) FolderToken

func (builder *CreateDocumentReqBodyBuilder) FolderToken(folderToken string) *CreateDocumentReqBodyBuilder

文件夹 token,获取方式见云文档接口快速入门;空表示根目录,tenant_access_token应用权限仅允许操作应用创建的目录

示例值:fldcnqquW1svRIYVT2Np6IuLCKd

func (*CreateDocumentReqBodyBuilder) Title

文档标题,只支持纯文本

示例值:undefined

type CreateDocumentReqBuilder

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

func NewCreateDocumentReqBuilder

func NewCreateDocumentReqBuilder() *CreateDocumentReqBuilder

func (*CreateDocumentReqBuilder) Body

创建新版文档,文档标题和目录可选。

func (*CreateDocumentReqBuilder) Build

func (builder *CreateDocumentReqBuilder) Build() *CreateDocumentReq

type CreateDocumentResp

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

func (*CreateDocumentResp) Success

func (resp *CreateDocumentResp) Success() bool

type CreateDocumentRespData

type CreateDocumentRespData struct {
	Document *Document `json:"document,omitempty"` // 新建文档的文档信息
}

type DeleteGridColumnRequest

type DeleteGridColumnRequest struct {
	ColumnIndex *int `json:"column_index,omitempty"` // 删除列索引,从 0 开始,如 0 表示删除第一列(-1表示删除最后一列)
}

type DeleteGridColumnRequestBuilder

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

func NewDeleteGridColumnRequestBuilder

func NewDeleteGridColumnRequestBuilder() *DeleteGridColumnRequestBuilder

func (*DeleteGridColumnRequestBuilder) Build

func (*DeleteGridColumnRequestBuilder) ColumnIndex

func (builder *DeleteGridColumnRequestBuilder) ColumnIndex(columnIndex int) *DeleteGridColumnRequestBuilder

删除列索引,从 0 开始,如 0 表示删除第一列(-1表示删除最后一列)

示例值:0

type DeleteTableColumnsRequest

type DeleteTableColumnsRequest struct {
	ColumnStartIndex *int `json:"column_start_index,omitempty"` // 列开始索引(区间左闭右开)
	ColumnEndIndex   *int `json:"column_end_index,omitempty"`   // 列结束索引(区间左闭右开)
}

type DeleteTableColumnsRequestBuilder

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

func NewDeleteTableColumnsRequestBuilder

func NewDeleteTableColumnsRequestBuilder() *DeleteTableColumnsRequestBuilder

func (*DeleteTableColumnsRequestBuilder) Build

func (*DeleteTableColumnsRequestBuilder) ColumnEndIndex

func (builder *DeleteTableColumnsRequestBuilder) ColumnEndIndex(columnEndIndex int) *DeleteTableColumnsRequestBuilder

列结束索引(区间左闭右开)

示例值:1

func (*DeleteTableColumnsRequestBuilder) ColumnStartIndex

func (builder *DeleteTableColumnsRequestBuilder) ColumnStartIndex(columnStartIndex int) *DeleteTableColumnsRequestBuilder

列开始索引(区间左闭右开)

示例值:0

type DeleteTableRowsRequest

type DeleteTableRowsRequest struct {
	RowStartIndex *int `json:"row_start_index,omitempty"` // 行开始索引(区间左闭右开)
	RowEndIndex   *int `json:"row_end_index,omitempty"`   // 行结束索引(区间左闭右开)
}

type DeleteTableRowsRequestBuilder

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

func NewDeleteTableRowsRequestBuilder

func NewDeleteTableRowsRequestBuilder() *DeleteTableRowsRequestBuilder

func (*DeleteTableRowsRequestBuilder) Build

func (*DeleteTableRowsRequestBuilder) RowEndIndex

func (builder *DeleteTableRowsRequestBuilder) RowEndIndex(rowEndIndex int) *DeleteTableRowsRequestBuilder

行结束索引(区间左闭右开)

示例值:1

func (*DeleteTableRowsRequestBuilder) RowStartIndex

func (builder *DeleteTableRowsRequestBuilder) RowStartIndex(rowStartIndex int) *DeleteTableRowsRequestBuilder

行开始索引(区间左闭右开)

示例值:0

type Diagram

type Diagram struct {
	DiagramType *int `json:"diagram_type,omitempty"` // 绘图类型
}

type DiagramBuilder

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

func NewDiagramBuilder

func NewDiagramBuilder() *DiagramBuilder

func (*DiagramBuilder) Build

func (builder *DiagramBuilder) Build() *Diagram

func (*DiagramBuilder) DiagramType

func (builder *DiagramBuilder) DiagramType(diagramType int) *DiagramBuilder

绘图类型

示例值:1

type Divider

type Divider struct {
}

type Document

type Document struct {
	DocumentId *string `json:"document_id,omitempty"` // 文档唯一标识
	RevisionId *int    `json:"revision_id,omitempty"` // 文档版本 ID
	Title      *string `json:"title,omitempty"`       // 文档标题
}

type DocumentBuilder

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

func NewDocumentBuilder

func NewDocumentBuilder() *DocumentBuilder

func (*DocumentBuilder) Build

func (builder *DocumentBuilder) Build() *Document

func (*DocumentBuilder) DocumentId

func (builder *DocumentBuilder) DocumentId(documentId string) *DocumentBuilder

文档唯一标识

示例值:doxcni6mOy7jLRWbEylaKKC7K88

func (*DocumentBuilder) RevisionId

func (builder *DocumentBuilder) RevisionId(revisionId int) *DocumentBuilder

文档版本 ID

示例值:1

func (*DocumentBuilder) Title

func (builder *DocumentBuilder) Title(title string) *DocumentBuilder

文档标题

示例值:undefined

type DocxService

type DocxService struct {
	Document              *document              // 文档
	DocumentBlock         *documentBlock         // 块
	DocumentBlockChildren *documentBlockChildren // document.block.children
	// contains filtered or unexported fields
}

func NewService

func NewService(config *larkcore.Config) *DocxService

type Equation

type Equation struct {
	Content *string `json:"content,omitempty"` // 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
}

type EquationBuilder

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

func NewEquationBuilder

func NewEquationBuilder() *EquationBuilder

func (*EquationBuilder) Build

func (builder *EquationBuilder) Build() *Equation

func (*EquationBuilder) Content

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

符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html

示例值:E=mc^2\n

type File

type File struct {
	Token *string `json:"token,omitempty"` // 附件 Token
	Name  *string `json:"name,omitempty"`  // 文件名
}

type FileBuilder

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

func NewFileBuilder

func NewFileBuilder() *FileBuilder

func (*FileBuilder) Build

func (builder *FileBuilder) Build() *File

func (*FileBuilder) Name

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

文件名

示例值:文件名

func (*FileBuilder) Token

func (builder *FileBuilder) Token(token string) *FileBuilder

附件 Token

示例值:boxbcOj88GDkmWGm2zsTyCBqoLb

type GetDocumentBlockChildrenIterator

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

func (*GetDocumentBlockChildrenIterator) Next

func (iterator *GetDocumentBlockChildrenIterator) Next() (bool, *Block, error)

func (*GetDocumentBlockChildrenIterator) NextPageToken

func (iterator *GetDocumentBlockChildrenIterator) NextPageToken() *string

type GetDocumentBlockChildrenReq

type GetDocumentBlockChildrenReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type GetDocumentBlockChildrenReqBuilder

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

func NewGetDocumentBlockChildrenReqBuilder

func NewGetDocumentBlockChildrenReqBuilder() *GetDocumentBlockChildrenReqBuilder

func (*GetDocumentBlockChildrenReqBuilder) BlockId

Block 的唯一标识

示例值:doxcnO6UW6wAw2qIcYf4hZpFIth

func (*GetDocumentBlockChildrenReqBuilder) Build

func (*GetDocumentBlockChildrenReqBuilder) DocumentId

文档的唯一标识

示例值:doxcnePuYufKa49ISjhD8Ih0ikh

func (*GetDocumentBlockChildrenReqBuilder) DocumentRevisionId

func (builder *GetDocumentBlockChildrenReqBuilder) DocumentRevisionId(documentRevisionId int) *GetDocumentBlockChildrenReqBuilder

操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限。

示例值:-1

func (*GetDocumentBlockChildrenReqBuilder) Limit

最大返回多少记录,当使用迭代器访问时才有效

func (*GetDocumentBlockChildrenReqBuilder) PageSize

分页大小

示例值:500

func (*GetDocumentBlockChildrenReqBuilder) PageToken

分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果

示例值:aw7DoMKBFMOGwqHCrcO8w6jCmMOvw6ILeADCvsKNw57Di8O5XGV3LG4_w5HCqhFxSnDCrCzCn0BgZcOYUg85EMOYcEAcwqYOw4ojw5QFwofCu8KoIMO3K8Ktw4IuNMOBBHNYw4bCgCV3U1zDu8K-J8KSR8Kgw7Y0fsKZdsKvW3d9w53DnkHDrcO5bDkYwrvDisOEPcOtVFJ-I03CnsOILMOoAmLDknd6dsKqG1bClAjDuS3CvcOTwo7Dg8OrwovDsRdqIcKxw5HDohTDtXN9w5rCkWo

func (*GetDocumentBlockChildrenReqBuilder) UserIdType

此次调用中使用的用户ID的类型

示例值:

type GetDocumentBlockChildrenResp

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

func (*GetDocumentBlockChildrenResp) Success

func (resp *GetDocumentBlockChildrenResp) Success() bool

type GetDocumentBlockChildrenRespData

type GetDocumentBlockChildrenRespData struct {
	Items     []*Block `json:"items,omitempty"`      // block 的 children 列表
	PageToken *string  `json:"page_token,omitempty"` // 下一个分页的分页标记
	HasMore   *bool    `json:"has_more,omitempty"`   // 是否还有下一个分页
}

type GetDocumentBlockReq

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

type GetDocumentBlockReqBuilder

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

func NewGetDocumentBlockReqBuilder

func NewGetDocumentBlockReqBuilder() *GetDocumentBlockReqBuilder

func (*GetDocumentBlockReqBuilder) BlockId

Block 的唯一标识

示例值:doxcnO6UW6wAw2qIcYf4hZpFIth

func (*GetDocumentBlockReqBuilder) Build

func (*GetDocumentBlockReqBuilder) DocumentId

func (builder *GetDocumentBlockReqBuilder) DocumentId(documentId string) *GetDocumentBlockReqBuilder

文档的唯一标识

示例值:doxcnePuYufKa49ISjhD8Ih0ikh

func (*GetDocumentBlockReqBuilder) DocumentRevisionId

func (builder *GetDocumentBlockReqBuilder) DocumentRevisionId(documentRevisionId int) *GetDocumentBlockReqBuilder

查询的文档版本,-1表示文档最新版本。若此时查询的版本为文档最新版本,则需要持有文档的阅读权限;若此时查询的版本为文档的历史版本,则需要持有文档的编辑权限。

示例值:-1

func (*GetDocumentBlockReqBuilder) UserIdType

func (builder *GetDocumentBlockReqBuilder) UserIdType(userIdType string) *GetDocumentBlockReqBuilder

此次调用中使用的用户ID的类型

示例值:

type GetDocumentBlockResp

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

func (*GetDocumentBlockResp) Success

func (resp *GetDocumentBlockResp) Success() bool

type GetDocumentBlockRespData

type GetDocumentBlockRespData struct {
	Block *Block `json:"block,omitempty"` // 查询的 Block 的信息
}

type GetDocumentReq

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

type GetDocumentReqBuilder

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

func NewGetDocumentReqBuilder

func NewGetDocumentReqBuilder() *GetDocumentReqBuilder

func (*GetDocumentReqBuilder) Build

func (builder *GetDocumentReqBuilder) Build() *GetDocumentReq

func (*GetDocumentReqBuilder) DocumentId

func (builder *GetDocumentReqBuilder) DocumentId(documentId string) *GetDocumentReqBuilder

文档的唯一标识

示例值:doxcnePuYufKa49ISjhD8Ih0ikh

type GetDocumentResp

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

func (*GetDocumentResp) Success

func (resp *GetDocumentResp) Success() bool

type GetDocumentRespData

type GetDocumentRespData struct {
	Document *Document `json:"document,omitempty"` // 文档信息
}

type Grid

type Grid struct {
	ColumnSize *int `json:"column_size,omitempty"` // 分栏列数量
}

type GridBuilder

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

func NewGridBuilder

func NewGridBuilder() *GridBuilder

func (*GridBuilder) Build

func (builder *GridBuilder) Build() *Grid

func (*GridBuilder) ColumnSize

func (builder *GridBuilder) ColumnSize(columnSize int) *GridBuilder

分栏列数量

示例值:2

type GridColumn

type GridColumn struct {
	WidthRatio *int `json:"width_ratio,omitempty"` // 当前分栏列占整个分栏的比例
}

type GridColumnBuilder

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

func NewGridColumnBuilder

func NewGridColumnBuilder() *GridColumnBuilder

func (*GridColumnBuilder) Build

func (builder *GridColumnBuilder) Build() *GridColumn

func (*GridColumnBuilder) WidthRatio

func (builder *GridColumnBuilder) WidthRatio(widthRatio int) *GridColumnBuilder

当前分栏列占整个分栏的比例

示例值:50

type Iframe

type Iframe struct {
	Component *IframeComponent `json:"component,omitempty"` // iframe 的组成元素
}

type IframeBuilder

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

func NewIframeBuilder

func NewIframeBuilder() *IframeBuilder

func (*IframeBuilder) Build

func (builder *IframeBuilder) Build() *Iframe

func (*IframeBuilder) Component

func (builder *IframeBuilder) Component(component *IframeComponent) *IframeBuilder

iframe 的组成元素

示例值:

type IframeComponent

type IframeComponent struct {
	IframeType *int    `json:"iframe_type,omitempty"` // iframe 类型
	Url        *string `json:"url,omitempty"`         // iframe 目标 url(需要进行 url_encode)
}

type IframeComponentBuilder

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

func NewIframeComponentBuilder

func NewIframeComponentBuilder() *IframeComponentBuilder

func (*IframeComponentBuilder) Build

func (builder *IframeComponentBuilder) Build() *IframeComponent

func (*IframeComponentBuilder) IframeType

func (builder *IframeComponentBuilder) IframeType(iframeType int) *IframeComponentBuilder

iframe 类型

示例值:1

func (*IframeComponentBuilder) Url

iframe 目标 url(需要进行 url_encode)

示例值:https%3A%2F%2Fwww.bilibili.com%2Fvideo%2FBV1Hi4y1w7V7

type Image

type Image struct {
	Width  *int    `json:"width,omitempty"`  // 宽度单位 px
	Height *int    `json:"height,omitempty"` // 高度
	Token  *string `json:"token,omitempty"`  // 图片 Token
}

type ImageBuilder

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

func NewImageBuilder

func NewImageBuilder() *ImageBuilder

func (*ImageBuilder) Build

func (builder *ImageBuilder) Build() *Image

func (*ImageBuilder) Height

func (builder *ImageBuilder) Height(height int) *ImageBuilder

高度

示例值:2480

func (*ImageBuilder) Token

func (builder *ImageBuilder) Token(token string) *ImageBuilder

图片 Token

示例值:boxbcVA91JtFgNhaCgy6s6wK4he

func (*ImageBuilder) Width

func (builder *ImageBuilder) Width(width int) *ImageBuilder

宽度单位 px

示例值:4069

type InlineBlock

type InlineBlock struct {
	BlockId *string `json:"block_id,omitempty"` // 关联的内联状态的 block 的 block_id
}

type InlineBlockBuilder

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

func NewInlineBlockBuilder

func NewInlineBlockBuilder() *InlineBlockBuilder

func (*InlineBlockBuilder) BlockId

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

关联的内联状态的 block 的 block_id

示例值:doxcnPFi0R56ctbvh2MjkkROFWf

func (*InlineBlockBuilder) Build

func (builder *InlineBlockBuilder) Build() *InlineBlock

type InlineFile

type InlineFile struct {
	FileToken     *string `json:"file_token,omitempty"`      // 附件 token
	SourceBlockId *string `json:"source_block_id,omitempty"` // 当前文档中该附件所处的 block 的 id
}

type InlineFileBuilder

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

func NewInlineFileBuilder

func NewInlineFileBuilder() *InlineFileBuilder

func (*InlineFileBuilder) Build

func (builder *InlineFileBuilder) Build() *InlineFile

func (*InlineFileBuilder) FileToken

func (builder *InlineFileBuilder) FileToken(fileToken string) *InlineFileBuilder

附件 token

示例值:boxcnOj88GDkmWGm2zsTyCBqoLb

func (*InlineFileBuilder) SourceBlockId

func (builder *InlineFileBuilder) SourceBlockId(sourceBlockId string) *InlineFileBuilder

当前文档中该附件所处的 block 的 id

示例值:doxcnM46kSWSkgUMW04ldKsJDsc

type InsertGridColumnRequest

type InsertGridColumnRequest struct {
	ColumnIndex *int `json:"column_index,omitempty"` // 插入列索引,从 1 开始,如 1 表示在第一列后插入,注意不允许传 0(-1表示在最后一列后插入)
}

type InsertGridColumnRequestBuilder

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

func NewInsertGridColumnRequestBuilder

func NewInsertGridColumnRequestBuilder() *InsertGridColumnRequestBuilder

func (*InsertGridColumnRequestBuilder) Build

func (*InsertGridColumnRequestBuilder) ColumnIndex

func (builder *InsertGridColumnRequestBuilder) ColumnIndex(columnIndex int) *InsertGridColumnRequestBuilder

插入列索引,从 1 开始,如 1 表示在第一列后插入,注意不允许传 0(-1表示在最后一列后插入)

示例值:1

type InsertTableColumnRequest

type InsertTableColumnRequest struct {
	ColumnIndex *int `json:"column_index,omitempty"` // 插入的列在表格中的索引。(-1表示在表格末尾插入一列)
}

type InsertTableColumnRequestBuilder

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

func NewInsertTableColumnRequestBuilder

func NewInsertTableColumnRequestBuilder() *InsertTableColumnRequestBuilder

func (*InsertTableColumnRequestBuilder) Build

func (*InsertTableColumnRequestBuilder) ColumnIndex

func (builder *InsertTableColumnRequestBuilder) ColumnIndex(columnIndex int) *InsertTableColumnRequestBuilder

插入的列在表格中的索引。(-1表示在表格末尾插入一列)

示例值:-1

type InsertTableRowRequest

type InsertTableRowRequest struct {
	RowIndex *int `json:"row_index,omitempty"` // 插入的行在表格中的索引。(-1表示在表格末尾插入一行)
}

type InsertTableRowRequestBuilder

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

func NewInsertTableRowRequestBuilder

func NewInsertTableRowRequestBuilder() *InsertTableRowRequestBuilder

func (*InsertTableRowRequestBuilder) Build

func (*InsertTableRowRequestBuilder) RowIndex

func (builder *InsertTableRowRequestBuilder) RowIndex(rowIndex int) *InsertTableRowRequestBuilder

插入的行在表格中的索引。(-1表示在表格末尾插入一行)

示例值:-1

type Isv

type Isv struct {
	ComponentId     *string `json:"component_id,omitempty"`      // 团队互动应用唯一ID
	ComponentTypeId *string `json:"component_type_id,omitempty"` // 团队互动应用类型,比如信息收集"blk_5f992038c64240015d280958"
}

type IsvBuilder

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

func NewIsvBuilder

func NewIsvBuilder() *IsvBuilder

func (*IsvBuilder) Build

func (builder *IsvBuilder) Build() *Isv

func (*IsvBuilder) ComponentId

func (builder *IsvBuilder) ComponentId(componentId string) *IsvBuilder

团队互动应用唯一ID

示例值:7056882725002051603

func (*IsvBuilder) ComponentTypeId

func (builder *IsvBuilder) ComponentTypeId(componentTypeId string) *IsvBuilder

团队互动应用类型,比如信息收集"blk_5f992038c64240015d280958"

示例值:blk_5f992038c64240015d280958

type Link struct {
	Url *string `json:"url,omitempty"` // 超链接指向的 url (需要 url_encode)
}

type LinkBuilder

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

func NewLinkBuilder

func NewLinkBuilder() *LinkBuilder

func (*LinkBuilder) Build

func (builder *LinkBuilder) Build() *Link

func (*LinkBuilder) Url

func (builder *LinkBuilder) Url(url string) *LinkBuilder

超链接指向的 url (需要 url_encode)

示例值:https%3A%2F%2Fopen.feishu.cn%2F

type ListDocumentBlockIterator

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

func (*ListDocumentBlockIterator) Next

func (iterator *ListDocumentBlockIterator) Next() (bool, *Block, error)

func (*ListDocumentBlockIterator) NextPageToken

func (iterator *ListDocumentBlockIterator) NextPageToken() *string

type ListDocumentBlockReq

type ListDocumentBlockReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type ListDocumentBlockReqBuilder

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

func NewListDocumentBlockReqBuilder

func NewListDocumentBlockReqBuilder() *ListDocumentBlockReqBuilder

func (*ListDocumentBlockReqBuilder) Build

func (*ListDocumentBlockReqBuilder) DocumentId

func (builder *ListDocumentBlockReqBuilder) DocumentId(documentId string) *ListDocumentBlockReqBuilder

文档的唯一标识

示例值:doxcnePuYufKa49ISjhD8Ih0ikh

func (*ListDocumentBlockReqBuilder) DocumentRevisionId

func (builder *ListDocumentBlockReqBuilder) DocumentRevisionId(documentRevisionId int) *ListDocumentBlockReqBuilder

查询的文档版本,-1表示文档最新版本。若此时查询的版本为文档最新版本,则需要持有文档的阅读权限;若此时查询的版本为文档的历史版本,则需要持有文档的编辑权限。

示例值:-1

func (*ListDocumentBlockReqBuilder) Limit

最大返回多少记录,当使用迭代器访问时才有效

func (*ListDocumentBlockReqBuilder) PageSize

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

分页大小

示例值:500

func (*ListDocumentBlockReqBuilder) PageToken

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

分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果

示例值:aw7DoMKBFMOGwqHCrcO8w6jCmMOvw6ILeADCvsKNw57Di8O5XGV3LG4_w5HCqhFxSnDCrCzCn0BgZcOYUg85EMOYcEAcwqYOw4ojw5QFwofCu8KoIMO3K8Ktw4IuNMOBBHNYw4bCgCV3U1zDu8K-J8KSR8Kgw7Y0fsKZdsKvW3d9w53DnkHDrcO5bDkYwrvDisOEPcOtVFJ-I03CnsOILMOoAmLDknd6dsKqG1bClAjDuS3CvcOTwo7Dg8OrwovDsRdqIcKxw5HDohTDtXN9w5rCkWo

func (*ListDocumentBlockReqBuilder) UserIdType

func (builder *ListDocumentBlockReqBuilder) UserIdType(userIdType string) *ListDocumentBlockReqBuilder

此次调用中使用的用户ID的类型

示例值:

type ListDocumentBlockResp

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

func (*ListDocumentBlockResp) Success

func (resp *ListDocumentBlockResp) Success() bool

type ListDocumentBlockRespData

type ListDocumentBlockRespData struct {
	Items     []*Block `json:"items,omitempty"`      // 文档的 Block 信息
	PageToken *string  `json:"page_token,omitempty"` // 下一个分页的分页标记
	HasMore   *bool    `json:"has_more,omitempty"`   // 是否还有下一个分页
}

type MentionDoc

type MentionDoc struct {
	Token   *string `json:"token,omitempty"`    // 云文档 token
	ObjType *int    `json:"obj_type,omitempty"` // 云文档类型
	Url     *string `json:"url,omitempty"`      // 云文档链接(需要 url_encode)
	Title   *string `json:"title,omitempty"`    // 文档标题,只读属性
}

type MentionDocBuilder

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

func NewMentionDocBuilder

func NewMentionDocBuilder() *MentionDocBuilder

func (*MentionDocBuilder) Build

func (builder *MentionDocBuilder) Build() *MentionDoc

func (*MentionDocBuilder) ObjType

func (builder *MentionDocBuilder) ObjType(objType int) *MentionDocBuilder

云文档类型

示例值:22

func (*MentionDocBuilder) Title

func (builder *MentionDocBuilder) Title(title string) *MentionDocBuilder

文档标题,只读属性

示例值:undefined

func (*MentionDocBuilder) Token

func (builder *MentionDocBuilder) Token(token string) *MentionDocBuilder

云文档 token

示例值:doxbc873Y7cXD153gXqb76G1Y9b

func (*MentionDocBuilder) Url

func (builder *MentionDocBuilder) Url(url string) *MentionDocBuilder

云文档链接(需要 url_encode)

示例值:https%3A%2F%2Fbytedance.feishu-boe.cn%2Fdocx%2Fdoxbc873Y7cXD153gXqb76G1Y9b

type MentionUser

type MentionUser struct {
	UserId *string `json:"user_id,omitempty"` // 用户 OpenID
}

type MentionUserBuilder

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

func NewMentionUserBuilder

func NewMentionUserBuilder() *MentionUserBuilder

func (*MentionUserBuilder) Build

func (builder *MentionUserBuilder) Build() *MentionUser

func (*MentionUserBuilder) UserId

func (builder *MentionUserBuilder) UserId(userId string) *MentionUserBuilder

用户 OpenID

示例值:ou_3bbe8a09c20e89cce9bff989ed840674

type MergeTableCellsRequest

type MergeTableCellsRequest struct {
	RowStartIndex    *int `json:"row_start_index,omitempty"`    // 行起始索引(区间左闭右开)
	RowEndIndex      *int `json:"row_end_index,omitempty"`      // 行结束索引(区间左闭右开)
	ColumnStartIndex *int `json:"column_start_index,omitempty"` // 列起始索引(区间左闭右开)
	ColumnEndIndex   *int `json:"column_end_index,omitempty"`   // 列结束索引(区间左闭右开)
}

type MergeTableCellsRequestBuilder

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

func NewMergeTableCellsRequestBuilder

func NewMergeTableCellsRequestBuilder() *MergeTableCellsRequestBuilder

func (*MergeTableCellsRequestBuilder) Build

func (*MergeTableCellsRequestBuilder) ColumnEndIndex

func (builder *MergeTableCellsRequestBuilder) ColumnEndIndex(columnEndIndex int) *MergeTableCellsRequestBuilder

列结束索引(区间左闭右开)

示例值:1

func (*MergeTableCellsRequestBuilder) ColumnStartIndex

func (builder *MergeTableCellsRequestBuilder) ColumnStartIndex(columnStartIndex int) *MergeTableCellsRequestBuilder

列起始索引(区间左闭右开)

示例值:0

func (*MergeTableCellsRequestBuilder) RowEndIndex

func (builder *MergeTableCellsRequestBuilder) RowEndIndex(rowEndIndex int) *MergeTableCellsRequestBuilder

行结束索引(区间左闭右开)

示例值:1

func (*MergeTableCellsRequestBuilder) RowStartIndex

func (builder *MergeTableCellsRequestBuilder) RowStartIndex(rowStartIndex int) *MergeTableCellsRequestBuilder

行起始索引(区间左闭右开)

示例值:0

type Mindnote

type Mindnote struct {
	Token *string `json:"token,omitempty"` // 思维导图 token
}

type MindnoteBuilder

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

func NewMindnoteBuilder

func NewMindnoteBuilder() *MindnoteBuilder

func (*MindnoteBuilder) Build

func (builder *MindnoteBuilder) Build() *Mindnote

func (*MindnoteBuilder) Token

func (builder *MindnoteBuilder) Token(token string) *MindnoteBuilder

思维导图 token

示例值:bmnbcXXGPWfJMwDfGCbCiU14c6f

type ObjectiveIdWithKrId

type ObjectiveIdWithKrId struct {
	ObjectiveId *string  `json:"objective_id,omitempty"` // okr 中 objective 的 ID
	KrIds       []string `json:"kr_ids,omitempty"`       // key result 的 ID 列表,此值为空时插入当前 objective 下的所有 key result
}

type ObjectiveIdWithKrIdBuilder

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

func NewObjectiveIdWithKrIdBuilder

func NewObjectiveIdWithKrIdBuilder() *ObjectiveIdWithKrIdBuilder

func (*ObjectiveIdWithKrIdBuilder) Build

func (*ObjectiveIdWithKrIdBuilder) KrIds

key result 的 ID 列表,此值为空时插入当前 objective 下的所有 key result

示例值:["7109022573011894300","7109022546444517404"]

func (*ObjectiveIdWithKrIdBuilder) ObjectiveId

func (builder *ObjectiveIdWithKrIdBuilder) ObjectiveId(objectiveId string) *ObjectiveIdWithKrIdBuilder

okr 中 objective 的 ID

示例值:"7109022409227026460"

type Okr

type Okr struct {
	OkrId               *string                `json:"okr_id,omitempty"`                // OKR ID
	Objectives          []*ObjectiveIdWithKrId `json:"objectives,omitempty"`            // OKR Block 中的 objective ID 和 key result ID,此值为空时插入 okr 下所有的 objective 和 key result
	PeriodDisplayStatus *string                `json:"period_display_status,omitempty"` // 周期的状态
	PeriodNameZh        *string                `json:"period_name_zh,omitempty"`        // 周期名 - 中文
	PeriodNameEn        *string                `json:"period_name_en,omitempty"`        // 周期名 - 英文
	UserId              *string                `json:"user_id,omitempty"`               // OKR 所属的用户 ID
	VisibleSetting      *OkrVisibleSetting     `json:"visible_setting,omitempty"`       // 可见性设置
}

type OkrBuilder

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

func NewOkrBuilder

func NewOkrBuilder() *OkrBuilder

func (*OkrBuilder) Build

func (builder *OkrBuilder) Build() *Okr

func (*OkrBuilder) Objectives

func (builder *OkrBuilder) Objectives(objectives []*ObjectiveIdWithKrId) *OkrBuilder

OKR Block 中的 objective ID 和 key result ID,此值为空时插入 okr 下所有的 objective 和 key result

示例值:

func (*OkrBuilder) OkrId

func (builder *OkrBuilder) OkrId(okrId string) *OkrBuilder

OKR ID

示例值:"7076349900476448796"

func (*OkrBuilder) PeriodDisplayStatus

func (builder *OkrBuilder) PeriodDisplayStatus(periodDisplayStatus string) *OkrBuilder

周期的状态

示例值:"default"

func (*OkrBuilder) PeriodNameEn

func (builder *OkrBuilder) PeriodNameEn(periodNameEn string) *OkrBuilder

周期名 - 英文

示例值:"Apr - Jun 2022"

func (*OkrBuilder) PeriodNameZh

func (builder *OkrBuilder) PeriodNameZh(periodNameZh string) *OkrBuilder

周期名 - 中文

示例值:"2022 年 4 月 - 6 月"

func (*OkrBuilder) UserId

func (builder *OkrBuilder) UserId(userId string) *OkrBuilder

OKR 所属的用户 ID

示例值:"ou_3bbe8a09c20e89cce9bff989ed840674"

func (*OkrBuilder) VisibleSetting

func (builder *OkrBuilder) VisibleSetting(visibleSetting *OkrVisibleSetting) *OkrBuilder

可见性设置

示例值:

type OkrKeyResult

type OkrKeyResult struct {
	KrId         *string          `json:"kr_id,omitempty"`         // key result 的 ID
	Confidential *bool            `json:"confidential,omitempty"`  // 是否设置过私密权限
	Position     *int             `json:"position,omitempty"`      // key result 的位置编号,对应 Block 中 KR1、KR2 的 1、2。
	Score        *int             `json:"score,omitempty"`         // 打分信息
	Visible      *bool            `json:"visible,omitempty"`       // OKR Block 中此 key result 是否可见
	Weight       *float64         `json:"weight,omitempty"`        // key result 的权重
	ProgressRate *OkrProgressRate `json:"progress_rate,omitempty"` // 进展信息
	Content      *Text            `json:"content,omitempty"`       // key result 的文本内容
}

type OkrKeyResultBuilder

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

func NewOkrKeyResultBuilder

func NewOkrKeyResultBuilder() *OkrKeyResultBuilder

func (*OkrKeyResultBuilder) Build

func (builder *OkrKeyResultBuilder) Build() *OkrKeyResult

func (*OkrKeyResultBuilder) Confidential

func (builder *OkrKeyResultBuilder) Confidential(confidential bool) *OkrKeyResultBuilder

是否设置过私密权限

示例值:false

func (*OkrKeyResultBuilder) Content

func (builder *OkrKeyResultBuilder) Content(content *Text) *OkrKeyResultBuilder

key result 的文本内容

示例值:

func (*OkrKeyResultBuilder) KrId

func (builder *OkrKeyResultBuilder) KrId(krId string) *OkrKeyResultBuilder

key result 的 ID

示例值:"7109022573011894300"

func (*OkrKeyResultBuilder) Position

func (builder *OkrKeyResultBuilder) Position(position int) *OkrKeyResultBuilder

key result 的位置编号,对应 Block 中 KR1、KR2 的 1、2。

示例值:1

func (*OkrKeyResultBuilder) ProgressRate

func (builder *OkrKeyResultBuilder) ProgressRate(progressRate *OkrProgressRate) *OkrKeyResultBuilder

进展信息

示例值:

func (*OkrKeyResultBuilder) Score

func (builder *OkrKeyResultBuilder) Score(score int) *OkrKeyResultBuilder

打分信息

示例值:0

func (*OkrKeyResultBuilder) Visible

func (builder *OkrKeyResultBuilder) Visible(visible bool) *OkrKeyResultBuilder

OKR Block 中此 key result 是否可见

示例值:true

func (*OkrKeyResultBuilder) Weight

func (builder *OkrKeyResultBuilder) Weight(weight float64) *OkrKeyResultBuilder

key result 的权重

示例值:0.5

type OkrObjective

type OkrObjective struct {
	ObjectiveId  *string          `json:"objective_id,omitempty"`  // objective ID
	Confidential *bool            `json:"confidential,omitempty"`  // 是否设置过私密权限
	Position     *int             `json:"position,omitempty"`      // objective 的位置编号,对应 Block 中 O1、O2 的 1、2
	Score        *int             `json:"score,omitempty"`         // 打分信息
	Visible      *bool            `json:"visible,omitempty"`       // OKR Block 中是否展示该 objective
	Weight       *float64         `json:"weight,omitempty"`        // objective 的权重
	ProgressRate *OkrProgressRate `json:"progress_rate,omitempty"` // 进展信息
	Content      *Text            `json:"content,omitempty"`       // objective 的文本内容
}

type OkrObjectiveBuilder

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

func NewOkrObjectiveBuilder

func NewOkrObjectiveBuilder() *OkrObjectiveBuilder

func (*OkrObjectiveBuilder) Build

func (builder *OkrObjectiveBuilder) Build() *OkrObjective

func (*OkrObjectiveBuilder) Confidential

func (builder *OkrObjectiveBuilder) Confidential(confidential bool) *OkrObjectiveBuilder

是否设置过私密权限

示例值:false

func (*OkrObjectiveBuilder) Content

func (builder *OkrObjectiveBuilder) Content(content *Text) *OkrObjectiveBuilder

objective 的文本内容

示例值:

func (*OkrObjectiveBuilder) ObjectiveId

func (builder *OkrObjectiveBuilder) ObjectiveId(objectiveId string) *OkrObjectiveBuilder

objective ID

示例值:"7109022409227026460"

func (*OkrObjectiveBuilder) Position

func (builder *OkrObjectiveBuilder) Position(position int) *OkrObjectiveBuilder

objective 的位置编号,对应 Block 中 O1、O2 的 1、2

示例值:1

func (*OkrObjectiveBuilder) ProgressRate

func (builder *OkrObjectiveBuilder) ProgressRate(progressRate *OkrProgressRate) *OkrObjectiveBuilder

进展信息

示例值:

func (*OkrObjectiveBuilder) Score

func (builder *OkrObjectiveBuilder) Score(score int) *OkrObjectiveBuilder

打分信息

示例值:0

func (*OkrObjectiveBuilder) Visible

func (builder *OkrObjectiveBuilder) Visible(visible bool) *OkrObjectiveBuilder

OKR Block 中是否展示该 objective

示例值:true

func (*OkrObjectiveBuilder) Weight

func (builder *OkrObjectiveBuilder) Weight(weight float64) *OkrObjectiveBuilder

objective 的权重

示例值:1.0

type OkrProgress

type OkrProgress struct {
}

type OkrProgressRate

type OkrProgressRate struct {
	Mode           *string  `json:"mode,omitempty"`            // 状态模式
	Current        *float64 `json:"current,omitempty"`         // 当前进度
	Percent        *float64 `json:"percent,omitempty"`         // 当前进度百分比,simple mode 下使用
	ProgressStatus *string  `json:"progress_status,omitempty"` // 进展状态
	Start          *float64 `json:"start,omitempty"`           // 进度起始值,advanced模式使用
	StatusType     *string  `json:"status_type,omitempty"`     // 状态类型
	Target         *float64 `json:"target,omitempty"`          // 进度目标值,advanced模式使用
}

type OkrProgressRateBuilder

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

func NewOkrProgressRateBuilder

func NewOkrProgressRateBuilder() *OkrProgressRateBuilder

func (*OkrProgressRateBuilder) Build

func (builder *OkrProgressRateBuilder) Build() *OkrProgressRate

func (*OkrProgressRateBuilder) Current

func (builder *OkrProgressRateBuilder) Current(current float64) *OkrProgressRateBuilder

当前进度

示例值:0

func (*OkrProgressRateBuilder) Mode

状态模式

示例值:"simple"

func (*OkrProgressRateBuilder) Percent

func (builder *OkrProgressRateBuilder) Percent(percent float64) *OkrProgressRateBuilder

当前进度百分比,simple mode 下使用

示例值:100

func (*OkrProgressRateBuilder) ProgressStatus

func (builder *OkrProgressRateBuilder) ProgressStatus(progressStatus string) *OkrProgressRateBuilder

进展状态

示例值:"normal"

func (*OkrProgressRateBuilder) Start

func (builder *OkrProgressRateBuilder) Start(start float64) *OkrProgressRateBuilder

进度起始值,advanced模式使用

示例值:0

func (*OkrProgressRateBuilder) StatusType

func (builder *OkrProgressRateBuilder) StatusType(statusType string) *OkrProgressRateBuilder

状态类型

示例值:"default"

func (*OkrProgressRateBuilder) Target

func (builder *OkrProgressRateBuilder) Target(target float64) *OkrProgressRateBuilder

进度目标值,advanced模式使用

示例值:

type OkrVisibleSetting

type OkrVisibleSetting struct {
	ProgressFillAreaVisible *bool `json:"progress_fill_area_visible,omitempty"` // 进展编辑区域是否可见
	ProgressStatusVisible   *bool `json:"progress_status_visible,omitempty"`    // 状态是否可见
	ScoreVisible            *bool `json:"score_visible,omitempty"`              // 分数是否可见
}

type OkrVisibleSettingBuilder

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

func NewOkrVisibleSettingBuilder

func NewOkrVisibleSettingBuilder() *OkrVisibleSettingBuilder

func (*OkrVisibleSettingBuilder) Build

func (builder *OkrVisibleSettingBuilder) Build() *OkrVisibleSetting

func (*OkrVisibleSettingBuilder) ProgressFillAreaVisible

func (builder *OkrVisibleSettingBuilder) ProgressFillAreaVisible(progressFillAreaVisible bool) *OkrVisibleSettingBuilder

进展编辑区域是否可见

示例值:true

func (*OkrVisibleSettingBuilder) ProgressStatusVisible

func (builder *OkrVisibleSettingBuilder) ProgressStatusVisible(progressStatusVisible bool) *OkrVisibleSettingBuilder

状态是否可见

示例值:true

func (*OkrVisibleSettingBuilder) ScoreVisible

func (builder *OkrVisibleSettingBuilder) ScoreVisible(scoreVisible bool) *OkrVisibleSettingBuilder

分数是否可见

示例值:true

type PatchDocumentBlockReq

type PatchDocumentBlockReq struct {
	UpdateBlockRequest *UpdateBlockRequest `body:""`
	// contains filtered or unexported fields
}

type PatchDocumentBlockReqBuilder

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

func NewPatchDocumentBlockReqBuilder

func NewPatchDocumentBlockReqBuilder() *PatchDocumentBlockReqBuilder

func (*PatchDocumentBlockReqBuilder) BlockId

Block 的唯一标识

示例值:doxcnO6UW6wAw2qIcYf4hZpFIth

func (*PatchDocumentBlockReqBuilder) Build

func (*PatchDocumentBlockReqBuilder) ClientToken

func (builder *PatchDocumentBlockReqBuilder) ClientToken(clientToken string) *PatchDocumentBlockReqBuilder

操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。

示例值:0e2633a3-aa1a-4171-af9e-0768ff863566

func (*PatchDocumentBlockReqBuilder) DocumentId

func (builder *PatchDocumentBlockReqBuilder) DocumentId(documentId string) *PatchDocumentBlockReqBuilder

文档的唯一标识

示例值:doxcnePuYufKa49ISjhD8Ih0ikh

func (*PatchDocumentBlockReqBuilder) DocumentRevisionId

func (builder *PatchDocumentBlockReqBuilder) DocumentRevisionId(documentRevisionId int) *PatchDocumentBlockReqBuilder

操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限。

示例值:-1

func (*PatchDocumentBlockReqBuilder) UpdateBlockRequest

func (builder *PatchDocumentBlockReqBuilder) UpdateBlockRequest(updateBlockRequest *UpdateBlockRequest) *PatchDocumentBlockReqBuilder

更新指定的块。

func (*PatchDocumentBlockReqBuilder) UserIdType

func (builder *PatchDocumentBlockReqBuilder) UserIdType(userIdType string) *PatchDocumentBlockReqBuilder

此次调用中使用的用户ID的类型

示例值:

type PatchDocumentBlockResp

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

func (*PatchDocumentBlockResp) Success

func (resp *PatchDocumentBlockResp) Success() bool

type PatchDocumentBlockRespData

type PatchDocumentBlockRespData struct {
	Block              *Block  `json:"block,omitempty"`                // 更新后的 block 信息
	DocumentRevisionId *int    `json:"document_revision_id,omitempty"` // 当前更新成功后文档的版本号
	ClientToken        *string `json:"client_token,omitempty"`         // 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新
}

type QuoteContainer

type QuoteContainer struct {
}

type RawContentDocumentReq

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

type RawContentDocumentReqBuilder

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

func NewRawContentDocumentReqBuilder

func NewRawContentDocumentReqBuilder() *RawContentDocumentReqBuilder

func (*RawContentDocumentReqBuilder) Build

func (*RawContentDocumentReqBuilder) DocumentId

func (builder *RawContentDocumentReqBuilder) DocumentId(documentId string) *RawContentDocumentReqBuilder

文档的唯一标识

示例值:doxbcmEtbFrbbq10nPNu8gO1F3b

func (*RawContentDocumentReqBuilder) Lang

语言(用于 MentionUser 语言的选取)

示例值:0

type RawContentDocumentResp

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

func (*RawContentDocumentResp) Success

func (resp *RawContentDocumentResp) Success() bool

type RawContentDocumentRespData

type RawContentDocumentRespData struct {
	Content *string `json:"content,omitempty"` // 文档纯文本
}

type Reminder

type Reminder struct {
	CreateUserId *string `json:"create_user_id,omitempty"` // 创建者用户 ID
	IsNotify     *bool   `json:"is_notify,omitempty"`      // 是否通知
	IsWholeDay   *bool   `json:"is_whole_day,omitempty"`   // 是日期还是整点小时
	ExpireTime   *string `json:"expire_time,omitempty"`    // 事件发生的时间(毫秒级事件戳)
	NotifyTime   *string `json:"notify_time,omitempty"`    // 触发通知的时间(毫秒级时间戳)
}

type ReminderBuilder

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

func NewReminderBuilder

func NewReminderBuilder() *ReminderBuilder

func (*ReminderBuilder) Build

func (builder *ReminderBuilder) Build() *Reminder

func (*ReminderBuilder) CreateUserId

func (builder *ReminderBuilder) CreateUserId(createUserId string) *ReminderBuilder

创建者用户 ID

示例值:0e2633a3-aa1a-4171-af9e-0768ff863566

func (*ReminderBuilder) ExpireTime

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

事件发生的时间(毫秒级事件戳)

示例值:1641967200000

func (*ReminderBuilder) IsNotify

func (builder *ReminderBuilder) IsNotify(isNotify bool) *ReminderBuilder

是否通知

示例值:true

func (*ReminderBuilder) IsWholeDay

func (builder *ReminderBuilder) IsWholeDay(isWholeDay bool) *ReminderBuilder

是日期还是整点小时

示例值:true

func (*ReminderBuilder) NotifyTime

func (builder *ReminderBuilder) NotifyTime(notifyTime string) *ReminderBuilder

触发通知的时间(毫秒级时间戳)

示例值:1643166000000

type ReplaceFileRequest

type ReplaceFileRequest struct {
	Token *string `json:"token,omitempty"` // 附件 token
}

type ReplaceFileRequestBuilder

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

func NewReplaceFileRequestBuilder

func NewReplaceFileRequestBuilder() *ReplaceFileRequestBuilder

func (*ReplaceFileRequestBuilder) Build

func (*ReplaceFileRequestBuilder) Token

附件 token

示例值:boxbckbfvfcqEg22hAzN8Dh9gJd

type ReplaceImageRequest

type ReplaceImageRequest struct {
	Token *string `json:"token,omitempty"` // 图片 token
}

type ReplaceImageRequestBuilder

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

func NewReplaceImageRequestBuilder

func NewReplaceImageRequestBuilder() *ReplaceImageRequestBuilder

func (*ReplaceImageRequestBuilder) Build

func (*ReplaceImageRequestBuilder) Token

图片 token

示例值:boxbckbfvfcqEg22hAzN8Dh9gJd

type Sheet

type Sheet struct {
	Token      *string `json:"token,omitempty"`       // 电子表格 block 的 token
	RowSize    *int    `json:"row_size,omitempty"`    // 电子表格行数量
	ColumnSize *int    `json:"column_size,omitempty"` // 电子表格列数量
}

type SheetBuilder

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

func NewSheetBuilder

func NewSheetBuilder() *SheetBuilder

func (*SheetBuilder) Build

func (builder *SheetBuilder) Build() *Sheet

func (*SheetBuilder) ColumnSize

func (builder *SheetBuilder) ColumnSize(columnSize int) *SheetBuilder

电子表格列数量

示例值:2

func (*SheetBuilder) RowSize

func (builder *SheetBuilder) RowSize(rowSize int) *SheetBuilder

电子表格行数量

示例值:2

func (*SheetBuilder) Token

func (builder *SheetBuilder) Token(token string) *SheetBuilder

电子表格 block 的 token

示例值:shtbcW6ufcUtRRet7Hz6Iv4ytzg

type Table

type Table struct {
	Cells    []string       `json:"cells,omitempty"`    // 单元格数组,数组元素为 Table Cell Block 的 ID
	Property *TableProperty `json:"property,omitempty"` // 表格属性
}

type TableBuilder

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

func NewTableBuilder

func NewTableBuilder() *TableBuilder

func (*TableBuilder) Build

func (builder *TableBuilder) Build() *Table

func (*TableBuilder) Cells

func (builder *TableBuilder) Cells(cells []string) *TableBuilder

单元格数组,数组元素为 Table Cell Block 的 ID

示例值:

func (*TableBuilder) Property

func (builder *TableBuilder) Property(property *TableProperty) *TableBuilder

表格属性

示例值:

type TableCell

type TableCell struct {
}

type TableMergeInfo

type TableMergeInfo struct {
	RowSpan *int `json:"row_span,omitempty"` // 从当前行索引起被合并的连续行数
	ColSpan *int `json:"col_span,omitempty"` // 从当前列索引起被合并的连续列数
}

type TableMergeInfoBuilder

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

func NewTableMergeInfoBuilder

func NewTableMergeInfoBuilder() *TableMergeInfoBuilder

func (*TableMergeInfoBuilder) Build

func (builder *TableMergeInfoBuilder) Build() *TableMergeInfo

func (*TableMergeInfoBuilder) ColSpan

func (builder *TableMergeInfoBuilder) ColSpan(colSpan int) *TableMergeInfoBuilder

从当前列索引起被合并的连续列数

示例值:2

func (*TableMergeInfoBuilder) RowSpan

func (builder *TableMergeInfoBuilder) RowSpan(rowSpan int) *TableMergeInfoBuilder

从当前行索引起被合并的连续行数

示例值:2

type TableProperty

type TableProperty struct {
	RowSize     *int              `json:"row_size,omitempty"`     // 行数
	ColumnSize  *int              `json:"column_size,omitempty"`  // 列数
	ColumnWidth []int             `json:"column_width,omitempty"` // 列宽,单位px
	MergeInfo   []*TableMergeInfo `json:"merge_info,omitempty"`   // 单元格合并信息
}

type TablePropertyBuilder

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

func NewTablePropertyBuilder

func NewTablePropertyBuilder() *TablePropertyBuilder

func (*TablePropertyBuilder) Build

func (builder *TablePropertyBuilder) Build() *TableProperty

func (*TablePropertyBuilder) ColumnSize

func (builder *TablePropertyBuilder) ColumnSize(columnSize int) *TablePropertyBuilder

列数

示例值:1

func (*TablePropertyBuilder) ColumnWidth

func (builder *TablePropertyBuilder) ColumnWidth(columnWidth []int) *TablePropertyBuilder

列宽,单位px

示例值:100

func (*TablePropertyBuilder) MergeInfo

func (builder *TablePropertyBuilder) MergeInfo(mergeInfo []*TableMergeInfo) *TablePropertyBuilder

单元格合并信息

示例值:

func (*TablePropertyBuilder) RowSize

func (builder *TablePropertyBuilder) RowSize(rowSize int) *TablePropertyBuilder

行数

示例值:1

type Task

type Task struct {
	TaskId *string `json:"task_id,omitempty"` // 任务 ID,查询具体任务详情见 https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/create
}

type TaskBuilder

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

func NewTaskBuilder

func NewTaskBuilder() *TaskBuilder

func (*TaskBuilder) Build

func (builder *TaskBuilder) Build() *Task

func (*TaskBuilder) TaskId

func (builder *TaskBuilder) TaskId(taskId string) *TaskBuilder

任务 ID,查询具体任务详情见 https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/create

示例值:

type Text

type Text struct {
	Style    *TextStyle     `json:"style,omitempty"`    // 文本样式
	Elements []*TextElement `json:"elements,omitempty"` // 文本元素
}

type TextBuilder

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

func NewTextBuilder

func NewTextBuilder() *TextBuilder

func (*TextBuilder) Build

func (builder *TextBuilder) Build() *Text

func (*TextBuilder) Elements

func (builder *TextBuilder) Elements(elements []*TextElement) *TextBuilder

文本元素

示例值:

func (*TextBuilder) Style

func (builder *TextBuilder) Style(style *TextStyle) *TextBuilder

文本样式

示例值:

type TextElement

type TextElement struct {
	TextRun     *TextRun          `json:"text_run,omitempty"`     // 文字
	MentionUser *MentionUser      `json:"mention_user,omitempty"` // @用户
	MentionDoc  *MentionDoc       `json:"mention_doc,omitempty"`  // @文档
	Reminder    *Reminder         `json:"reminder,omitempty"`     // 日期提醒
	File        *InlineFile       `json:"file,omitempty"`         // 内联附件
	Undefined   *UndefinedElement `json:"undefined,omitempty"`    // 未支持的 TextElement
	InlineBlock *InlineBlock      `json:"inline_block,omitempty"` // 内联 block
	Equation    *Equation         `json:"equation,omitempty"`     // 公式
}

type TextElementBuilder

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

func NewTextElementBuilder

func NewTextElementBuilder() *TextElementBuilder

func (*TextElementBuilder) Build

func (builder *TextElementBuilder) Build() *TextElement

func (*TextElementBuilder) Equation

func (builder *TextElementBuilder) Equation(equation *Equation) *TextElementBuilder

公式

示例值:

func (*TextElementBuilder) File

func (builder *TextElementBuilder) File(file *InlineFile) *TextElementBuilder

内联附件

示例值:

func (*TextElementBuilder) InlineBlock

func (builder *TextElementBuilder) InlineBlock(inlineBlock *InlineBlock) *TextElementBuilder

内联 block

示例值:

func (*TextElementBuilder) MentionDoc

func (builder *TextElementBuilder) MentionDoc(mentionDoc *MentionDoc) *TextElementBuilder

@文档

示例值:

func (*TextElementBuilder) MentionUser

func (builder *TextElementBuilder) MentionUser(mentionUser *MentionUser) *TextElementBuilder

@用户

示例值:

func (*TextElementBuilder) Reminder

func (builder *TextElementBuilder) Reminder(reminder *Reminder) *TextElementBuilder

日期提醒

示例值:

func (*TextElementBuilder) TextRun

func (builder *TextElementBuilder) TextRun(textRun *TextRun) *TextElementBuilder

文字

示例值:

func (*TextElementBuilder) Undefined

func (builder *TextElementBuilder) Undefined(undefined *UndefinedElement) *TextElementBuilder

未支持的 TextElement

示例值:

type TextElementStyle

type TextElementStyle struct {
	Bold            *bool `json:"bold,omitempty"`             // 加粗
	Italic          *bool `json:"italic,omitempty"`           // 斜体
	Strikethrough   *bool `json:"strikethrough,omitempty"`    // 删除线
	Underline       *bool `json:"underline,omitempty"`        // 下划线
	InlineCode      *bool `json:"inline_code,omitempty"`      // inline 代码
	BackgroundColor *int  `json:"background_color,omitempty"` // 背景色
	TextColor       *int  `json:"text_color,omitempty"`       // 字体颜色
	Link            *Link `json:"link,omitempty"`             // 链接
}

type TextElementStyleBuilder

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

func NewTextElementStyleBuilder

func NewTextElementStyleBuilder() *TextElementStyleBuilder

func (*TextElementStyleBuilder) BackgroundColor

func (builder *TextElementStyleBuilder) BackgroundColor(backgroundColor int) *TextElementStyleBuilder

背景色

示例值:1

func (*TextElementStyleBuilder) Bold

加粗

示例值:true

func (*TextElementStyleBuilder) Build

func (builder *TextElementStyleBuilder) Build() *TextElementStyle

func (*TextElementStyleBuilder) InlineCode

func (builder *TextElementStyleBuilder) InlineCode(inlineCode bool) *TextElementStyleBuilder

inline 代码

示例值:true

func (*TextElementStyleBuilder) Italic

func (builder *TextElementStyleBuilder) Italic(italic bool) *TextElementStyleBuilder

斜体

示例值:true

链接

示例值:

func (*TextElementStyleBuilder) Strikethrough

func (builder *TextElementStyleBuilder) Strikethrough(strikethrough bool) *TextElementStyleBuilder

删除线

示例值:true

func (*TextElementStyleBuilder) TextColor

func (builder *TextElementStyleBuilder) TextColor(textColor int) *TextElementStyleBuilder

字体颜色

示例值:1

func (*TextElementStyleBuilder) Underline

func (builder *TextElementStyleBuilder) Underline(underline bool) *TextElementStyleBuilder

下划线

示例值:true

type TextRun

type TextRun struct {
	Content          *string           `json:"content,omitempty"`            // 文本内容
	TextElementStyle *TextElementStyle `json:"text_element_style,omitempty"` // 文本局部样式
}

type TextRunBuilder

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

func NewTextRunBuilder

func NewTextRunBuilder() *TextRunBuilder

func (*TextRunBuilder) Build

func (builder *TextRunBuilder) Build() *TextRun

func (*TextRunBuilder) Content

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

文本内容

示例值:文本

func (*TextRunBuilder) TextElementStyle

func (builder *TextRunBuilder) TextElementStyle(textElementStyle *TextElementStyle) *TextRunBuilder

文本局部样式

示例值:

type TextStyle

type TextStyle struct {
	Align    *int  `json:"align,omitempty"`    // 对齐方式
	Done     *bool `json:"done,omitempty"`     // todo 的完成状态
	Folded   *bool `json:"folded,omitempty"`   // 文本的折叠状态
	Language *int  `json:"language,omitempty"` // 代码块语言
	Wrap     *bool `json:"wrap,omitempty"`     // 代码块是否自动换行
}

type TextStyleBuilder

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

func NewTextStyleBuilder

func NewTextStyleBuilder() *TextStyleBuilder

func (*TextStyleBuilder) Align

func (builder *TextStyleBuilder) Align(align int) *TextStyleBuilder

对齐方式

示例值:1

func (*TextStyleBuilder) Build

func (builder *TextStyleBuilder) Build() *TextStyle

func (*TextStyleBuilder) Done

func (builder *TextStyleBuilder) Done(done bool) *TextStyleBuilder

todo 的完成状态

示例值:true

func (*TextStyleBuilder) Folded

func (builder *TextStyleBuilder) Folded(folded bool) *TextStyleBuilder

文本的折叠状态

示例值:true

func (*TextStyleBuilder) Language

func (builder *TextStyleBuilder) Language(language int) *TextStyleBuilder

代码块语言

示例值:1

func (*TextStyleBuilder) Wrap

func (builder *TextStyleBuilder) Wrap(wrap bool) *TextStyleBuilder

代码块是否自动换行

示例值:true

type Undefined

type Undefined struct {
}

type UndefinedElement

type UndefinedElement struct {
}

type UnmergeTableCellsRequest

type UnmergeTableCellsRequest struct {
	RowIndex    *int `json:"row_index,omitempty"`    // table 行索引
	ColumnIndex *int `json:"column_index,omitempty"` // table 列索引
}

type UnmergeTableCellsRequestBuilder

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

func NewUnmergeTableCellsRequestBuilder

func NewUnmergeTableCellsRequestBuilder() *UnmergeTableCellsRequestBuilder

func (*UnmergeTableCellsRequestBuilder) Build

func (*UnmergeTableCellsRequestBuilder) ColumnIndex

func (builder *UnmergeTableCellsRequestBuilder) ColumnIndex(columnIndex int) *UnmergeTableCellsRequestBuilder

table 列索引

示例值:0

func (*UnmergeTableCellsRequestBuilder) RowIndex

table 行索引

示例值:0

type UpdateBlockRequest

type UpdateBlockRequest struct {
	UpdateTextElements         *UpdateTextElementsRequest         `json:"update_text_elements,omitempty"`           // 更新文本元素请求
	UpdateTextStyle            *UpdateTextStyleRequest            `json:"update_text_style,omitempty"`              // 更新文本样式请求
	UpdateTableProperty        *UpdateTablePropertyRequest        `json:"update_table_property,omitempty"`          // 更新表格属性请求
	InsertTableRow             *InsertTableRowRequest             `json:"insert_table_row,omitempty"`               // 表格插入新行请求
	InsertTableColumn          *InsertTableColumnRequest          `json:"insert_table_column,omitempty"`            // 表格插入新列请求
	DeleteTableRows            *DeleteTableRowsRequest            `json:"delete_table_rows,omitempty"`              // 表格批量删除行请求
	DeleteTableColumns         *DeleteTableColumnsRequest         `json:"delete_table_columns,omitempty"`           // 表格批量删除列请求
	MergeTableCells            *MergeTableCellsRequest            `json:"merge_table_cells,omitempty"`              // 表格合并单元格请求
	UnmergeTableCells          *UnmergeTableCellsRequest          `json:"unmerge_table_cells,omitempty"`            // 表格取消单元格合并状态请求
	InsertGridColumn           *InsertGridColumnRequest           `json:"insert_grid_column,omitempty"`             // 分栏插入新的分栏列请求
	DeleteGridColumn           *DeleteGridColumnRequest           `json:"delete_grid_column,omitempty"`             // 分栏删除列请求
	UpdateGridColumnWidthRatio *UpdateGridColumnWidthRatioRequest `json:"update_grid_column_width_ratio,omitempty"` // 更新分栏列宽比例请求
	ReplaceImage               *ReplaceImageRequest               `json:"replace_image,omitempty"`                  // 替换图片请求
	ReplaceFile                *ReplaceFileRequest                `json:"replace_file,omitempty"`                   // 替换附件请求
	BlockId                    *string                            `json:"block_id,omitempty"`                       // Block 唯一标识
	UpdateText                 *UpdateTextRequest                 `json:"update_text,omitempty"`                    // 更新文本元素及样式请求
}

type UpdateBlockRequestBuilder

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

func NewUpdateBlockRequestBuilder

func NewUpdateBlockRequestBuilder() *UpdateBlockRequestBuilder

func (*UpdateBlockRequestBuilder) BlockId

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

Block 唯一标识

示例值:doxcnSS4ouQkQEouGSUkTg9NJPe

func (*UpdateBlockRequestBuilder) Build

func (*UpdateBlockRequestBuilder) DeleteGridColumn

func (builder *UpdateBlockRequestBuilder) DeleteGridColumn(deleteGridColumn *DeleteGridColumnRequest) *UpdateBlockRequestBuilder

分栏删除列请求

示例值:

func (*UpdateBlockRequestBuilder) DeleteTableColumns

func (builder *UpdateBlockRequestBuilder) DeleteTableColumns(deleteTableColumns *DeleteTableColumnsRequest) *UpdateBlockRequestBuilder

表格批量删除列请求

示例值:

func (*UpdateBlockRequestBuilder) DeleteTableRows

func (builder *UpdateBlockRequestBuilder) DeleteTableRows(deleteTableRows *DeleteTableRowsRequest) *UpdateBlockRequestBuilder

表格批量删除行请求

示例值:

func (*UpdateBlockRequestBuilder) InsertGridColumn

func (builder *UpdateBlockRequestBuilder) InsertGridColumn(insertGridColumn *InsertGridColumnRequest) *UpdateBlockRequestBuilder

分栏插入新的分栏列请求

示例值:

func (*UpdateBlockRequestBuilder) InsertTableColumn

func (builder *UpdateBlockRequestBuilder) InsertTableColumn(insertTableColumn *InsertTableColumnRequest) *UpdateBlockRequestBuilder

表格插入新列请求

示例值:

func (*UpdateBlockRequestBuilder) InsertTableRow

func (builder *UpdateBlockRequestBuilder) InsertTableRow(insertTableRow *InsertTableRowRequest) *UpdateBlockRequestBuilder

表格插入新行请求

示例值:

func (*UpdateBlockRequestBuilder) MergeTableCells

func (builder *UpdateBlockRequestBuilder) MergeTableCells(mergeTableCells *MergeTableCellsRequest) *UpdateBlockRequestBuilder

表格合并单元格请求

示例值:

func (*UpdateBlockRequestBuilder) ReplaceFile

func (builder *UpdateBlockRequestBuilder) ReplaceFile(replaceFile *ReplaceFileRequest) *UpdateBlockRequestBuilder

替换附件请求

示例值:

func (*UpdateBlockRequestBuilder) ReplaceImage

func (builder *UpdateBlockRequestBuilder) ReplaceImage(replaceImage *ReplaceImageRequest) *UpdateBlockRequestBuilder

替换图片请求

示例值:

func (*UpdateBlockRequestBuilder) UnmergeTableCells

func (builder *UpdateBlockRequestBuilder) UnmergeTableCells(unmergeTableCells *UnmergeTableCellsRequest) *UpdateBlockRequestBuilder

表格取消单元格合并状态请求

示例值:

func (*UpdateBlockRequestBuilder) UpdateGridColumnWidthRatio

func (builder *UpdateBlockRequestBuilder) UpdateGridColumnWidthRatio(updateGridColumnWidthRatio *UpdateGridColumnWidthRatioRequest) *UpdateBlockRequestBuilder

更新分栏列宽比例请求

示例值:

func (*UpdateBlockRequestBuilder) UpdateTableProperty

func (builder *UpdateBlockRequestBuilder) UpdateTableProperty(updateTableProperty *UpdateTablePropertyRequest) *UpdateBlockRequestBuilder

更新表格属性请求

示例值:

func (*UpdateBlockRequestBuilder) UpdateText

func (builder *UpdateBlockRequestBuilder) UpdateText(updateText *UpdateTextRequest) *UpdateBlockRequestBuilder

更新文本元素及样式请求

示例值:

func (*UpdateBlockRequestBuilder) UpdateTextElements

func (builder *UpdateBlockRequestBuilder) UpdateTextElements(updateTextElements *UpdateTextElementsRequest) *UpdateBlockRequestBuilder

更新文本元素请求

示例值:

func (*UpdateBlockRequestBuilder) UpdateTextStyle

func (builder *UpdateBlockRequestBuilder) UpdateTextStyle(updateTextStyle *UpdateTextStyleRequest) *UpdateBlockRequestBuilder

更新文本样式请求

示例值:

type UpdateGridColumnWidthRatioRequest

type UpdateGridColumnWidthRatioRequest struct {
	WidthRatios []int `json:"width_ratios,omitempty"` // 更新列宽比例时,需要传入所有列宽占比
}

type UpdateGridColumnWidthRatioRequestBuilder

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

func NewUpdateGridColumnWidthRatioRequestBuilder

func NewUpdateGridColumnWidthRatioRequestBuilder() *UpdateGridColumnWidthRatioRequestBuilder

func (*UpdateGridColumnWidthRatioRequestBuilder) Build

func (*UpdateGridColumnWidthRatioRequestBuilder) WidthRatios

更新列宽比例时,需要传入所有列宽占比

示例值:50

type UpdateTablePropertyRequest

type UpdateTablePropertyRequest struct {
	ColumnWidth *int `json:"column_width,omitempty"` // 表格列宽
	ColumnIndex *int `json:"column_index,omitempty"` // 需要修改列宽的表格列的索引
}

type UpdateTablePropertyRequestBuilder

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

func NewUpdateTablePropertyRequestBuilder

func NewUpdateTablePropertyRequestBuilder() *UpdateTablePropertyRequestBuilder

func (*UpdateTablePropertyRequestBuilder) Build

func (*UpdateTablePropertyRequestBuilder) ColumnIndex

func (builder *UpdateTablePropertyRequestBuilder) ColumnIndex(columnIndex int) *UpdateTablePropertyRequestBuilder

需要修改列宽的表格列的索引

示例值:0

func (*UpdateTablePropertyRequestBuilder) ColumnWidth

func (builder *UpdateTablePropertyRequestBuilder) ColumnWidth(columnWidth int) *UpdateTablePropertyRequestBuilder

表格列宽

示例值:100

type UpdateTextElementsRequest

type UpdateTextElementsRequest struct {
	Elements []*TextElement `json:"elements,omitempty"` // 更新的文本元素列表,单次更新中 reminder 上限 30 个,mention_doc 上限 50 个,mention_user 上限 100 个
}

type UpdateTextElementsRequestBuilder

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

func NewUpdateTextElementsRequestBuilder

func NewUpdateTextElementsRequestBuilder() *UpdateTextElementsRequestBuilder

func (*UpdateTextElementsRequestBuilder) Build

func (*UpdateTextElementsRequestBuilder) Elements

更新的文本元素列表,单次更新中 reminder 上限 30 个,mention_doc 上限 50 个,mention_user 上限 100 个

示例值:

type UpdateTextRequest

type UpdateTextRequest struct {
	Elements []*TextElement `json:"elements,omitempty"` // 更新的文本元素列表,单次更新中 reminder 上限 30 个,mention_doc 上限 50 个,mention_user 上限 100 个
	Style    *TextStyle     `json:"style,omitempty"`    // 更新的文本样式
	Fields   []int          `json:"fields,omitempty"`   // 文本样式中应更新的字段,必须至少指定一个字段。例如,要调整 Block 对齐方式,请设置 fields 为 [1]。
}

type UpdateTextRequestBuilder

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

func NewUpdateTextRequestBuilder

func NewUpdateTextRequestBuilder() *UpdateTextRequestBuilder

func (*UpdateTextRequestBuilder) Build

func (builder *UpdateTextRequestBuilder) Build() *UpdateTextRequest

func (*UpdateTextRequestBuilder) Elements

func (builder *UpdateTextRequestBuilder) Elements(elements []*TextElement) *UpdateTextRequestBuilder

更新的文本元素列表,单次更新中 reminder 上限 30 个,mention_doc 上限 50 个,mention_user 上限 100 个

示例值:

func (*UpdateTextRequestBuilder) Fields

func (builder *UpdateTextRequestBuilder) Fields(fields []int) *UpdateTextRequestBuilder

文本样式中应更新的字段,必须至少指定一个字段。例如,要调整 Block 对齐方式,请设置 fields 为 [1]。

示例值:[1]

func (*UpdateTextRequestBuilder) Style

更新的文本样式

示例值:

type UpdateTextStyleRequest

type UpdateTextStyleRequest struct {
	Style  *TextStyle `json:"style,omitempty"`  // 文本样式
	Fields []int      `json:"fields,omitempty"` // 应更新的字段,必须至少指定一个字段。例如,要调整 Block 对齐方式,请设置 fields 为 [1]。
}

type UpdateTextStyleRequestBuilder

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

func NewUpdateTextStyleRequestBuilder

func NewUpdateTextStyleRequestBuilder() *UpdateTextStyleRequestBuilder

func (*UpdateTextStyleRequestBuilder) Build

func (*UpdateTextStyleRequestBuilder) Fields

应更新的字段,必须至少指定一个字段。例如,要调整 Block 对齐方式,请设置 fields 为 [1]。

示例值:修改的文字样式属性

func (*UpdateTextStyleRequestBuilder) Style

文本样式

示例值:

type View

type View struct {
	ViewType *int `json:"view_type,omitempty"` // 视图类型
}

type ViewBuilder

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

func NewViewBuilder

func NewViewBuilder() *ViewBuilder

func (*ViewBuilder) Build

func (builder *ViewBuilder) Build() *View

func (*ViewBuilder) ViewType

func (builder *ViewBuilder) ViewType(viewType int) *ViewBuilder

视图类型

示例值:1

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL