larkpassport

package
v3.3.2 Latest Latest
Warning

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

Go to latest
Published: Aug 23, 2024 License: MIT Imports: 4 Imported by: 6

Documentation

Index

Constants

View Source
const (
	UserIdTypeOpenId  = "open_id"  // 用户的 open id
	UserIdTypeUnionId = "union_id" // 用户的 union id
	UserIdTypeUserId  = "user_id"  // 用户的 user id
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Credentials

type Credentials struct {
	Email  *string `json:"email,omitempty"`   // 邮箱
	Mobile *string `json:"mobile,omitempty"`  // 手机号
	UserId *string `json:"user_id,omitempty"` // 用户id
}

type CredentialsBuilder

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

func NewCredentialsBuilder

func NewCredentialsBuilder() *CredentialsBuilder

func (*CredentialsBuilder) Build

func (builder *CredentialsBuilder) Build() *Credentials

func (*CredentialsBuilder) Email

func (builder *CredentialsBuilder) Email(email string) *CredentialsBuilder

邮箱

示例值:q*****@qq.com

func (*CredentialsBuilder) Mobile

func (builder *CredentialsBuilder) Mobile(mobile string) *CredentialsBuilder

手机号

示例值:186*****01

func (*CredentialsBuilder) UserId

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

用户id

示例值:

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 Device added in v3.2.5

type Device struct {
	DeviceId       *string `json:"device_id,omitempty"`        // 当前设备ID
	LegacyDeviceId *string `json:"legacy_device_id,omitempty"` // 历史使用的设备ID
}

type DeviceBuilder added in v3.2.5

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

func NewDeviceBuilder added in v3.2.5

func NewDeviceBuilder() *DeviceBuilder

func (*DeviceBuilder) Build added in v3.2.5

func (builder *DeviceBuilder) Build() *Device

func (*DeviceBuilder) DeviceId added in v3.2.5

func (builder *DeviceBuilder) DeviceId(deviceId string) *DeviceBuilder

当前设备ID

示例值:1234

func (*DeviceBuilder) LegacyDeviceId added in v3.2.5

func (builder *DeviceBuilder) LegacyDeviceId(legacyDeviceId string) *DeviceBuilder

历史使用的设备ID

示例值:4567

type IdpCredential

type IdpCredential struct {
}

type IdpCredentialId

type IdpCredentialId struct {
	IdpCredentialId *string `json:"idp_credential_id,omitempty"` // idp侧租户唯一标识
}

type IdpCredentialIdBuilder

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

func NewIdpCredentialIdBuilder

func NewIdpCredentialIdBuilder() *IdpCredentialIdBuilder

func (*IdpCredentialIdBuilder) Build

func (builder *IdpCredentialIdBuilder) Build() *IdpCredentialId

func (*IdpCredentialIdBuilder) IdpCredentialId

func (builder *IdpCredentialIdBuilder) IdpCredentialId(idpCredentialId string) *IdpCredentialIdBuilder

idp侧租户唯一标识

示例值:

type MaskSession

type MaskSession struct {
	CreateTime   *string `json:"create_time,omitempty"`   // 创建时间
	TerminalType *int    `json:"terminal_type,omitempty"` // 客户端类型
	UserId       *string `json:"user_id,omitempty"`       // 用户ID
}

type MaskSessionBuilder

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

func NewMaskSessionBuilder

func NewMaskSessionBuilder() *MaskSessionBuilder

func (*MaskSessionBuilder) Build

func (builder *MaskSessionBuilder) Build() *MaskSession

func (*MaskSessionBuilder) CreateTime

func (builder *MaskSessionBuilder) CreateTime(createTime string) *MaskSessionBuilder

创建时间

示例值:

func (*MaskSessionBuilder) TerminalType

func (builder *MaskSessionBuilder) TerminalType(terminalType int) *MaskSessionBuilder

客户端类型

示例值:

func (*MaskSessionBuilder) UserId

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

用户ID

示例值:

type QuerySessionPathReqBodyBuilder

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

func NewQuerySessionPathReqBodyBuilder

func NewQuerySessionPathReqBodyBuilder() *QuerySessionPathReqBodyBuilder

func (*QuerySessionPathReqBodyBuilder) Build

func (*QuerySessionPathReqBodyBuilder) UserIds

用户 ID

示例值:["47f621ff"]

type QuerySessionReq

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

type QuerySessionReqBody

type QuerySessionReqBody struct {
	UserIds []string `json:"user_ids,omitempty"` // 用户 ID
}

type QuerySessionReqBodyBuilder

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

func NewQuerySessionReqBodyBuilder

func NewQuerySessionReqBodyBuilder() *QuerySessionReqBodyBuilder

func (*QuerySessionReqBodyBuilder) Build

func (*QuerySessionReqBodyBuilder) UserIds

func (builder *QuerySessionReqBodyBuilder) UserIds(userIds []string) *QuerySessionReqBodyBuilder

用户 ID

示例值:["47f621ff"]

type QuerySessionReqBuilder

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

func NewQuerySessionReqBuilder

func NewQuerySessionReqBuilder() *QuerySessionReqBuilder

func (*QuerySessionReqBuilder) Body

该接口用于查询用户的登录信息

func (*QuerySessionReqBuilder) Build

func (builder *QuerySessionReqBuilder) Build() *QuerySessionReq

func (*QuerySessionReqBuilder) UserIdType

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

示例值:open_id

type QuerySessionResp

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

func (*QuerySessionResp) Success

func (resp *QuerySessionResp) Success() bool

type QuerySessionRespData

type QuerySessionRespData struct {
	MaskSessions []*MaskSession `json:"mask_sessions,omitempty"` // 用户登录信息
}

type V1 added in v3.1.0

type V1 struct {
	Session *session // 登录态
}

func New added in v3.1.0

func New(config *larkcore.Config) *V1

Jump to

Keyboard shortcuts

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