space

Documentation

Index

• type DescribeNodeRequest
  • func NewDescribeNodeRequest() (request *DescribeNodeRequest)
• type DescribeNodeResponse
• type DescribeNodesRequest
  • func NewDescribeNodesRequest() (request *DescribeNodesRequest)
• type DescribeNodesResponse
• type DescribeSpacesRequest
  • func NewDescribeSpacesRequest() (request *DescribeSpacesRequest)
• type DescribeSpacesResponse
• type NodeBaseInfo
• type NodeDetail
• type NodeResponse
• type NodeType
• type Space
  • func NewSpace(credential *common.Credential, spaceId string, ...) (space *Space, err error)
  • func (c *Space) DescribeNode(request *DescribeNodeRequest) (node *NodeDetail, err error)
  • func (c *Space) DescribeNodes(request *DescribeNodesRequest) (node []*NodeBaseInfo, err error)
  • func (c *Space) DescribeSpaces(request *DescribeSpacesRequest) (spaces []*SpaceBaseInfo, err error)
• type SpaceBaseInfo
• type SpaceResponse

Types

type DescribeNodeRequest

type DescribeNodeRequest struct {
	*athttp.BaseRequest
	NodeId *string
}

DescribeNodeRequest node list request

func NewDescribeNodeRequest

func NewDescribeNodeRequest() (request *DescribeNodeRequest)

type DescribeNodeResponse

type DescribeNodeResponse struct {
	*athttp.BaseResponse
	// api response data
	Data *NodeDetail `json:"data"`
}

DescribeNodeResponse node detail response

type DescribeNodesRequest

type DescribeNodesRequest struct {
	*athttp.BaseRequest
}

DescribeNodesRequest node list request

func NewDescribeNodesRequest

func NewDescribeNodesRequest() (request *DescribeNodesRequest)

type DescribeNodesResponse

type DescribeNodesResponse struct {
	*athttp.BaseResponse
	// api response data
	Data *NodeResponse `json:"data"`
}

DescribeNodesResponse node list response data

type DescribeSpacesRequest

type DescribeSpacesRequest struct {
	*athttp.BaseRequest
}

DescribeSpacesRequest space list request

func NewDescribeSpacesRequest

func NewDescribeSpacesRequest() (request *DescribeSpacesRequest)

NewDescribeSpacesRequest init get spaces request instance

type DescribeSpacesResponse

type DescribeSpacesResponse struct {
	*athttp.BaseResponse
	// api response data
	Data *SpaceResponse `json:"data"`
}

DescribeSpacesResponse space list response data

type NodeBaseInfo

type NodeBaseInfo struct {
	// Id node id
	Id *string `json:"id,omitempty" name:"id"`
	// Name node name
	Name *string `json:"name,omitempty" name:"name"`
	// Type type of the node
	Type *NodeType `json:"type,omitempty" name:"type"`
	// Icon node icon
	Icon *string `json:"icon,omitempty" name:"icon"`
	// IsFav is the node in the favorite folder
	IsFav *bool `json:"isFav,omitempty" name:"isFav"`
}

NodeBaseInfo node base info

type NodeDetail

type NodeDetail struct {
	NodeBaseInfo
	Children []*NodeBaseInfo `json:"children,omitempty" name:"children"`
}

NodeDetail node detail

type NodeResponse

type NodeResponse struct {
	Nodes []*NodeBaseInfo `json:"nodes"`
}

NodeResponse node list response

type NodeType

type NodeType string

const (
	NodeType_Datasheet NodeType = "Datasheet"
	NodeType_Folder    NodeType = "Folder"
	NodeType_Form      NodeType = "Form"
	NodeType_Dashboard NodeType = "Dashboard"
)

type Space

type Space struct {
	common.Client
	SpaceId string
}

func NewSpace

func NewSpace(credential *common.Credential, spaceId string, clientProfile *profile.ClientProfile) (space *Space, err error)

NewSpace init space instance

func (*Space) DescribeNode

func (c *Space) DescribeNode(request *DescribeNodeRequest) (node *NodeDetail, err error)

DescribeNode get node detail

func (*Space) DescribeNodes

func (c *Space) DescribeNodes(request *DescribeNodesRequest) (node []*NodeBaseInfo, err error)

DescribeNodes get all space nodes

func (*Space) DescribeSpaces

func (c *Space) DescribeSpaces(request *DescribeSpacesRequest) (spaces []*SpaceBaseInfo, err error)

DescribeSpaces get all user's spaces list

type SpaceBaseInfo

type SpaceBaseInfo struct {
	// Id spaceId
	Id *string `json:"id,omitempty" name:"id"`
	// Name space name
	Name *string `json:"name,omitempty" name:"name"`
	// IsAdmin the manager of the space
	IsAdmin *bool `json:"isAdmin,omitempty" name:"isAdmin"`
}

SpaceBaseInfo describe the property of the space

type SpaceResponse

type SpaceResponse struct {
	Spaces []*SpaceBaseInfo `json:"spaces"`
}

SpaceResponse space list response