service

package
v1.0.8 Latest Latest
Warning

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

 Go to latest Published: Dec 5, 2020 License: BSD-3-Clause Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AbstractService 

type AbstractService struct {
	Endpoint      *config.Endpoint
	ServiceClient *utils.ServiceClient
}

AbstractService ***

type AccessTokenService 

type AccessTokenService struct {
	AbstractService //base class

	Credential         *config.Credential
	AccessTokenStorage *config.AccessTokenStorage
}

AccessTokenService ***

func NewAccessTokenService 

func NewAccessTokenService(serviceClient *utils.ServiceClient,
	endpoint *config.Endpoint, credential *config.Credential) *AccessTokenService

NewAccessTokenService 获取AccessToken http://static.bimface.com/book/restful/articles/api/accesstoken.html

func (*AccessTokenService) Get 

func (o *AccessTokenService) Get() (*response.AccessToken, error)

Get ***

func (*AccessTokenService) Grant 

func (o *AccessTokenService) Grant() (*response.AccessToken, error)

Grant ***

type AppendFileService 

type AppendFileService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
	SupportFileService *SupportFileService
}

AppendFileService ***

func NewAppendFileService 

func NewAppendFileService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService,
	supportFileService *SupportFileService) *AppendFileService

NewAppendFileService ***

func (*AppendFileService) QueryAppendFile 

func (o *AppendFileService) QueryAppendFile(appendFileID int64) (*response.AppendFile, error)

QueryAppendFile same to QueryAppendFileWithAccessToken ** 字段 类型 必填 描述 appendFileId Number Y append file id **

func (*AppendFileService) QueryAppendFileWithAccessToken 

func (o *AppendFileService) QueryAppendFileWithAccessToken(appendFileID int64, token string) (*response.AppendFile, error)

QueryAppendFileWithAccessToken 断点续传: 查询追加文件信息 http://static.bimface.com/book/restful/articles/api/append/query-appendfile.html ** 字段 类型 必填 描述 appendFileId Number Y append file id **

func (*AppendFileService) UploadAppendFile 

func (o *AppendFileService) UploadAppendFile(file *multipart.FileHeader, appendFileID int64) (*response.AppendFile, error)

UploadAppendFile 断点续传: 追加上传 http://static.bimface.com/book/restful/articles/api/append/upload-appendfile.html ** 字段 类型 必填 描述 appendFileId Number Y 追加文件id position Number N 追加上传开始位置，默认为0 **

type BakeService added in v1.0.4 

type BakeService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

BakeService ***

func NewBakeService added in v1.0.4 

func NewBakeService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *BakeService

NewBakeService ***

func (*BakeService) CreateFileBake added in v1.0.4 

func (o *BakeService) CreateFileBake(fileId int64, config map[string]string) (*response.Bake, error)

CreateFileBake 为文件创建bake数据包 https://static.bimface.com/restful-apidoc/dist/bakeDatabag.html#_createtranslatebakedatabagusingput

func (*BakeService) CreateFileDefaultBake added in v1.0.4 

func (o *BakeService) CreateFileDefaultBake(fileId int64) (*response.Bake, error)

CreateFileDefaultBake ***

func (*BakeService) CreateIntgrBake added in v1.0.4 

func (o *BakeService) CreateIntgrBake(intgrId int64, config map[string]string) (*response.Bake, error)

CreateIntgrBake 为集成模型创建bake数据包 https://static.bimface.com/restful-apidoc/dist/bakeDatabag.html#_createintegratebakedatabagusingput

func (*BakeService) CreateIntgrDefaultBake added in v1.0.4 

func (o *BakeService) CreateIntgrDefaultBake(intgrId int64) (*response.Bake, error)

CreateIntgrDefaultBake ***

func (*BakeService) GetFileBake added in v1.0.4 

func (o *BakeService) GetFileBake(fileId int64) ([]*response.Bake, error)

GetFileBake 查询文件bake数据包 https://static.bimface.com/restful-apidoc/dist/bakeDatabag.html#_gettranslatebakedatabagusingget

func (*BakeService) GetIntgrBake added in v1.0.4 

func (o *BakeService) GetIntgrBake(intgrId int64) ([]*response.Bake, error)

GetIntgrBake 查询集成模型bake数据包 https://static.bimface.com/restful-apidoc/dist/bakeDatabag.html#_getintegratebakedatabagusingget

type CategoryTreeService 

type CategoryTreeService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

CategoryTreeService ***

func NewCategoryTreeService 

func NewCategoryTreeService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *CategoryTreeService

NewCategoryTreeService ***

func (*CategoryTreeService) GetCategoryTree 

func (o *CategoryTreeService) GetCategoryTree(fileID int64) ([]*response.Category, error)

GetCategoryTree 文件转换相关: 获取单文件的所有构件类别、族和族类型树, 结果数据版本：1.0（1.0版本结果数据） ** 字段 类型 必填 描述 fileId Number Y 文件ID **

func (*CategoryTreeService) GetCategoryTreeResp 

func (o *CategoryTreeService) GetCategoryTreeResp(fileID int64, isV2 bool) (*req.Resp, error)

GetCategoryTreeResp 文件转换相关: 获取单文件的所有构件类别、族和族类型树 http://static.bimface.com/book/restful/articles/api/translate/get-hierarchy.html 1）获取1.0版本结果数据； 2）获取2.0版本结果数据 ** 字段 类型 必填 描述 fileId Number Y 文件ID v String N 结果数据版本：1.0（1.0版本结果数据）2.0（2.0版本结果数据） 默认为1.0数据 **

func (*CategoryTreeService) GetCategoryTreeV2 

func (o *CategoryTreeService) GetCategoryTreeV2(fileID int64) ([]*common.TreeNode, error)

GetCategoryTreeV2 文件转换相关: 获取单文件的所有构件类别、族和族类型树, 结果数据版本：2.0（2.0版本结果数据） ** 字段 类型 必填 描述 fileId Number Y 文件ID **

type CompareService 

type CompareService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

CompareService ***

func NewCompareService 

func NewCompareService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *CompareService

NewCompareService ***

func (*CompareService) Compare 

func (o *CompareService) Compare(compareRequst *request.CompareRequest) (*response.CompareStatus, error)

Compare 发起模型对比 http://static.bimface.com/book/restful/articles/api/compare/post-compare.html ** 字段 类型 必填 描述 previousFileId Number N 变更前文件ID，如果为新增文件，则为null followingFileId Number N 变更后文件ID，如果为删除文件，则为null sources Source[] Y 数组，多个CompareSource，待对比的文件 name String N 用户指定对比后的模型的名字 sourceId String N 第三方应用自己的ID priority Number N 优先级，数字越大，优先级越低 1, 2, 3 callback String N Callback地址，待对比完毕以后，BIMFace会回调该地址 **

func (*CompareService) GetCompareData 

func (o *CompareService) GetCompareData(compareID int64) ([]*response.CompareData, error)

GetCompareData 获取模型对比结果 http://static.bimface.com/book/restful/articles/api/compare/get-compare-rst.html ** 字段 类型 必填 描述 compareId Number Y 模型对比Id **

func (*CompareService) GetCompareDataResp 

func (o *CompareService) GetCompareDataResp(compareID int64) (*req.Resp, error)

GetCompareDataResp ***

func (*CompareService) GetCompareElementDiff 

func (o *CompareService) GetCompareElementDiff(compareID int64, previousFileID int64, previousElementID string,
	followingFileID int64, followingElementID string) (*response.ElementDiff, error)

GetCompareElementDiff 获取修改构件属性差异, same to GetCompareElementDiffWithParams ** 字段 类型 必填 描述 compareId Number Y 模型对比ID previousFileId Number Y 对比差异构件来源文件ID previousElementId String Y 对比差异构件来源构件ID followingFileId Number Y 对比差异构件变更文件ID followingElementId String Y 对比差异构件互为变更构件ID **

func (*CompareService) GetCompareElementDiffWithParams 

func (o *CompareService) GetCompareElementDiffWithParams(compareID int64, params req.QueryParam) (*response.ElementDiff, error)

GetCompareElementDiffWithParams 获取修改构件属性差异 http://static.bimface.com/book/restful/articles/api/compare/get-compare-ele-diff.html

func (*CompareService) GetCompareElementResp 

func (o *CompareService) GetCompareElementResp(compareID int64, params req.QueryParam) (*req.Resp, error)

GetCompareElementResp ***

func (*CompareService) GetCompareStatus 

func (o *CompareService) GetCompareStatus(compareID int64) (*response.CompareStatus, error)

GetCompareStatus 获取模型对比状态 http://static.bimface.com/book/restful/articles/api/compare/get-compare.html ** 字段 类型 必填 描述 compareId Number Y 模型对比ID **

func (*CompareService) GetCompareStatusResp 

func (o *CompareService) GetCompareStatusResp(compareID int64) (*req.Resp, error)

GetCompareStatusResp ***

type DatabagService 

type DatabagService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

DatabagService ***

func NewDatabagService 

func NewDatabagService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *DatabagService

NewDatabagService ***

func (*DatabagService) CreateDatabag 

func (o *DatabagService) CreateDatabag(databagRequest *request.DatabagRequest) (*response.Databag, error)

CreateDatabag 离线数据包相关: 创建离线数据包 http://static.bimface.com/book/restful/articles/api/offlinedatabag/create-offlinedatabag.html ** 字段 类型 必填 描述 fileId Number Y 通过文件转换ID创建离线数据包时必填 integrateId Number Y 通过集成模型ID创建离线数据包时必填 compareId Number Y 通过模型对比ID创建离线数据包时必填 callback String N 回调url **

func (*DatabagService) GetDatabagDownloadURL 

func (o *DatabagService) GetDatabagDownloadURL(databagRequest *request.DatabagRequest) (string, error)

GetDatabagDownloadURL 离线数据包相关: 获取离线数据包下载地址 http://static.bimface.com/book/restful/articles/api/offlinedatabag/get-download-offlinedataba-url.html ** 字段 类型 必填 描述 fileId Number Y 通过文件转换ID获取离线数据包下载地址时必填 integrateId Number Y 通过集成模型ID获取离线数据包下载地址时必填 compareId Number Y 通过模型对比ID获取离线数据包下载地址时必填 type String Y 值必须是“offline” databagVersion String N 数据包版本，如果只有一个，则下载唯一的数据包，如果多个，则必须指定数据包版本, 例如 3.0 **

func (*DatabagService) QueryDatabag 

func (o *DatabagService) QueryDatabag(databagRequest *request.DatabagRequest) ([]*response.Databag, error)

QueryDatabag 离线数据包相关: 查询离线数据包 http://static.bimface.com/book/restful/articles/api/offlinedatabag/query-offlinedataba.html ** 字段 类型 必填 描述 fileId Number Y 通过文件转换ID创建离线数据包时必填 integrateId Number Y 通过集成模型ID创建离线数据包时必填 compareId Number Y 通过模型对比ID创建离线数据包时必填 **

type DownloadService 

type DownloadService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

DownloadService ***

func NewDownloadService 

func NewDownloadService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *DownloadService

NewDownloadService ***

func (*DownloadService) GetDownloadResp 

func (o *DownloadService) GetDownloadResp(fileID int64, fileName string) (*req.Resp, error)

GetDownloadResp 下载文件 ** 字段 类型 必填 描述 fileId Number Y 文件Id name String N 自定义文件下载名 **

func (*DownloadService) GetDownloadURL 

func (o *DownloadService) GetDownloadURL(fileID int64, fileName string) (string, error)

GetDownloadURL 源文件相关: 获取文件下载地址 http://static.bimface.com/book/restful/articles/api/file/get-download-url.html ** 字段 类型 必填 描述 fileId Number Y 文件Id name String N 自定义文件下载名 **

type DrawingSheetsService 

type DrawingSheetsService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

DrawingSheetsService ***

func NewDrawingSheetsService 

func NewDrawingSheetsService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *DrawingSheetsService

NewDrawingSheetsService ***

func (*DrawingSheetsService) GetDrawingSheets 

func (o *DrawingSheetsService) GetDrawingSheets(fileID int64) (map[string]interface{}, error)

GetDrawingSheets 文件转换相关: 获取文件转换的二维图纸信息 http://static.bimface.com/book/restful/articles/api/translate/get-drawingsheets.html http API return json data such as:

[ 

{
	"portsAndViews": null,
	"viewInfo": {
		"cropBox": [
			-30480,
			-30480,
			-304800,
			30480,
			30480,
			-30.480000000000004
		],
		"elevation": 0,
		"id": "382617",
		"levelId": "",
		"name": "A102 - Plans",
		"outline": [
			2.4999999998688107,
			-1.0000000000133762,
			842.4999999998686,
			592.9999999999862
		],
		"preview": {
			"height": 724,
			"path": "m.bimface.com/e766f8bb69915a822b009e0fee6f2280/resource/thumbnails/382617/382617.png",
			"width": 1024
		},
		"thumbnails": [
			"m.bimface.com/e766f8bb69915a822b009e0fee6f2280/resource/thumbnails/382617/382617.96x96.png"
		],
		"viewPoint": {
			"origin": [
				0,
				0,
				0
			],
			"rightDirection": [
				1,
				0,
				0
			],
			"scale": 1,
			"upDirection": [
				0,
				1,
				0
			],
			"viewDirection": [
				0,
				0,
				1
			]
		},
		"viewType": "DrawingSheet"
	}
},

{...same as above ...},
{...same as above ...}

]

type ElementService 

type ElementService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

ElementService ***

func NewElementService 

func NewElementService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *ElementService

NewElementService ***

func (*ElementService) GetElements 

func (o *ElementService) GetElements(fileID int64, floor, specialty, categoryID,
	family, familyType string) ([]string, error)

GetElements 文件转换相关: 获取文件转换的构件列表 http://static.bimface.com/restful-apidoc/dist/translateSingleModel.html#_getelementidsusingget ** 字段 类型 必填 描述 fileId Number Y 文件ID specialty String N 专业 floor String N 楼层 categoryId String N 构件分类ID family String N 族 familyType String N 族类型 *** 其他参数详见网址地址 **

func (*ElementService) GetElementsResp 

func (o *ElementService) GetElementsResp(fileID int64, params req.QueryParam) (*req.Resp, error)

GetElementsResp *** http://static.bimface.com/restful-apidoc/dist/translateSingleModel.html#_getelementidsusingget

func (*ElementService) GetElementsWithParams 

func (o *ElementService) GetElementsWithParams(fileID int64, params req.QueryParam) ([]string, error)

GetElementsWithParams 文件转换相关: 获取文件转换的构件列表 必填参数: fileID params相关参数，详见 http://static.bimface.com/restful-apidoc/dist/translateSingleModel.html#_getelementidsusingget

func (*ElementService) GetIntgrElements 

func (o *ElementService) GetIntgrElements(fileID int64, floor, specialty, categoryID,
	family, familyType string) (*response.IntgrElements, error)

GetIntgrElements 模型集成相关: 获取集成的构件列表 http://doc.bimface.com/book/restful/articles/api/integrate/get-integrate-element.html ** 字段 类型 必填 描述 integrateId Number Y 集成ID specialty String N 专业 floor String N 楼层 categoryId String N 构件分类ID family String N 族 familyType String N 族类型 **

func (*ElementService) GetIntgrElementsResp 

func (o *ElementService) GetIntgrElementsResp(integrateID int64, params req.QueryParam) (*req.Resp, error)

GetIntgrElementsResp ***

func (*ElementService) GetIntgrElementsWithParams 

func (o *ElementService) GetIntgrElementsWithParams(integrateID int64, params req.QueryParam) (*response.IntgrElements, error)

GetIntgrElementsWithParams ***

type FloorService 

type FloorService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

FloorService ***

func NewFloorService 

func NewFloorService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *FloorService

NewFloorService ***

func (*FloorService) GetFloors 

func (o *FloorService) GetFloors(fileID int64) ([]*response.Floor, error)

GetFloors 获取文件转换的楼层信息 http://static.bimface.com/book/restful/articles/api/translate/get-floors.html

func (*FloorService) GetFloorsResp 

func (o *FloorService) GetFloorsResp(fileID int64) (*req.Resp, error)

GetFloorsResp ***

func (*FloorService) GetIntegrationFloors 

func (o *FloorService) GetIntegrationFloors(integrateID int64) ([]*response.Floor, error)

GetIntegrationFloors 获取集成模型楼层信息 http://static.bimface.com/book/restful/articles/api/integrate/get-integrate-floors.html

func (*FloorService) GetIntegrationFloorsResp 

func (o *FloorService) GetIntegrationFloorsResp(integrateID int64) (*req.Resp, error)

GetIntegrationFloorsResp ***

type IntegrateService 

type IntegrateService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

IntegrateService ***

func NewIntegrateService 

func NewIntegrateService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *IntegrateService

NewIntegrateService ***

func (*IntegrateService) DeleteIntegrate 

func (o *IntegrateService) DeleteIntegrate(integrateID int64) (string, error)

DeleteIntegrate 模型集成相关: 删除集成模型 http://doc.bimface.com/book/restful/articles/api/integrate/delete-integrate.html

func (*IntegrateService) GetIntegrateStatus 

func (o *IntegrateService) GetIntegrateStatus(integrateID int64) (*response.IntgrStatus, error)

GetIntegrateStatus 模型集成相关: 获取集成状态 http://doc.bimface.com/book/restful/articles/api/integrate/get-integrate.html

func (*IntegrateService) GetIntegrateStatusResp 

func (o *IntegrateService) GetIntegrateStatusResp(integrateID int64) (*req.Resp, error)

GetIntegrateStatusResp ***

func (*IntegrateService) Integrate 

func (o *IntegrateService) Integrate(intgrRequest *request.IntgrRequest) (*response.IntgrStatus, error)

Integrate 模型集成相关: 发起模型集成 http://doc.bimface.com/book/restful/articles/api/integrate/put-integrate.html ** 字段 类型 必填 描述 示例 sources Source[] Y 待集成的文件列表 source.fileId Number Y 待集成的源文件ID，必须是 rvt 文件 source.specialty String N 待集成源文件对应的专业名称 AR source.specialtySort Number N 显示专业层次结构时，排序数值越小，排序越前 source.floor String N 待集成源文件对应的楼层名称 F01 source.floorSort Number N 显示楼层层次结构时，排序数值越小，排序越前 sourceId String N 调用方的源ID name String N 调用方设置的名称 priority Number Y 优先级，数字越大，优先级越低 1, 2, 3 callback String N Callback地址，待集成完毕以后，BIMFACE会回调该地址 **

type IntgrTreeService 

type IntgrTreeService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

IntgrTreeService ***

func NewIntgrTreeService 

func NewIntgrTreeService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *IntgrTreeService

NewIntgrTreeService ***

func (*IntgrTreeService) GetFloorTree 

func (o *IntgrTreeService) GetFloorTree(integrateID int64) (*response.IntgrFloorTree, error)

GetFloorTree 按楼层视图,获取集成模型的构件层次结构 ** 字段 类型 必填 描述 integrateId Number Y 集成ID **

func (*IntgrTreeService) GetSpecialtyTree 

func (o *IntgrTreeService) GetSpecialtyTree(integrateID int64) (*response.IntgrSpecialtyTree, error)

GetSpecialtyTree 按专业视图,获取集成模型的构件层次结构 ** 字段 类型 必填 描述 integrateId Number Y 集成ID **

func (*IntgrTreeService) GetTreeResp 

func (o *IntgrTreeService) GetTreeResp(integrateID int64, treeType int) (*req.Resp, error)

GetTreeResp 模型集成相关: 获取集成模型的构件层次结构 模型集成以后，可以获取两种构件的层次结构：1）按专业视图；2）按楼层视图 http://static.bimface.com/book/restful/articles/api/integrate/get-integrate-tree.html ** 字段 类型 必填 描述 integrateId Number Y 集成ID treeType Number Y 树类型：1（按专业视图）2（按楼层视图） **

type PropertyService 

type PropertyService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

PropertyService ***

func NewPropertyService 

func NewPropertyService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *PropertyService

NewPropertyService ***

func (*PropertyService) GetElementProperties added in v1.0.8 

func (o *PropertyService) GetElementProperties(fileID int64) ([]*response.Element, error)

func (*PropertyService) GetElementPropertiesResp added in v1.0.8 

func (o *PropertyService) GetElementPropertiesResp(fileID int64) (*req.Resp, error)

GetElementPropertyResp ***

func (*PropertyService) GetElementProperty 

func (o *PropertyService) GetElementProperty(fileID int64, elementID string) (*response.Element, error)

GetElementProperty 文件转换相关: 获取文件转换的构件属性 http://static.bimface.com/restful-apidoc/dist/translateSingleModel.html#_getelementusingget_1 ** 字段 类型 必填 描述 fileId Number Y 文件ID elementId String Y 构件ID **

func (*PropertyService) GetElementPropertyResp 

func (o *PropertyService) GetElementPropertyResp(fileID int64, elementID string) (*req.Resp, error)

GetElementPropertyResp ***

func (*PropertyService) GetIntgrElementProperty 

func (o *PropertyService) GetIntgrElementProperty(integrateID int64, elementID string) (*response.Element, error)

GetIntgrElementProperty 模型集成相关: 获取集成模型的构件属性 http://static.bimface.com/book/restful/articles/api/integrate/get-integrate-element-prop.html ** 字段 类型 必填 描述 fileId Number Y 文件ID elementId String Y 构件ID **

func (*PropertyService) GetIntgrElementPropertyResp 

func (o *PropertyService) GetIntgrElementPropertyResp(integrateID int64, elementID string) (*req.Resp, error)

GetIntgrElementPropertyResp ***

type ShareLinkService 

type ShareLinkService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

ShareLinkService ***

func NewShareLinkService 

func NewShareLinkService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *ShareLinkService

NewShareLinkService ***

func (*ShareLinkService) CreateShare 

func (o *ShareLinkService) CreateShare(fileID int64, activeHours int, expireDate string, needPassword bool) (*response.ShareLink, error)

CreateShare 文件发起转换以后，根据fileId生成该文件的分享链接 http://static.bimface.com/book/restful/articles/api/share/create-sharelink.html ** 字段 类型 必填 描述 fileId Number N (集成ID二选一) 文件ID integrateId Number N (文件ID二选一) 集成ID activeHours Number N 有效时长，单位：小时，如果不设置表示永久有效 **

func (*ShareLinkService) CreateShareIntegration 

func (o *ShareLinkService) CreateShareIntegration(integrateID int64, activeHours int, expireDate string, needPassword bool) (*response.ShareLink, error)

CreateShareIntegration 发起集成模型以后，根据integrateId生成集成模型的分享链接 http://static.bimface.com/book/restful/articles/api/share/create-sharelink.html ** 字段 类型 必填 描述 fileId Number N (集成ID二选一) 文件ID integrateId Number N (文件ID二选一) 集成ID activeHours Number N 有效时长，单位：小时，如果不设置表示永久有效 **

func (*ShareLinkService) CreateShareTranslation 

func (o *ShareLinkService) CreateShareTranslation(fileID int64, activeHours int, expireDate string, needPassword bool) (*response.ShareLink, error)

CreateShareTranslation same to CreateShare

func (*ShareLinkService) DeleteShare 

func (o *ShareLinkService) DeleteShare(fileID int64) (string, error)

DeleteShare 取消分享: 文件转换以后 分享的链接 http://static.bimface.com/book/restful/articles/api/share/delete-sharelink.html

func (*ShareLinkService) DeleteShareIntegration 

func (o *ShareLinkService) DeleteShareIntegration(integrateID int64) (string, error)

DeleteShareIntegration 取消分享: 集成模型以后 分享的链接 http://static.bimface.com/book/restful/articles/api/share/delete-sharelink.html

func (*ShareLinkService) DeleteShareTranslation 

func (o *ShareLinkService) DeleteShareTranslation(fileID int64) (string, error)

DeleteShareTranslation same to DeleteShare

func (*ShareLinkService) DeleteShares added in v1.0.6 

func (o *ShareLinkService) DeleteShares(soruceIds []int64) (string, error)

func (*ShareLinkService) GetShares added in v1.0.6 

func (o *ShareLinkService) GetShares(pageNo int, pageSize int) ([]*response.ShareLink, error)

type SupportFileService 

type SupportFileService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

SupportFileService ***

func NewSupportFileService 

func NewSupportFileService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *SupportFileService

NewSupportFileService ***

func (*SupportFileService) GetSupport 

func (o *SupportFileService) GetSupport() (*response.SupportFile, error)

GetSupport ***

func (*SupportFileService) GetSupportWithAccessToken 

func (o *SupportFileService) GetSupportWithAccessToken(token string) (*response.SupportFile, error)

GetSupportWithAccessToken ***

type TranslateService 

type TranslateService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

TranslateService ***

func NewTranslateService 

func NewTranslateService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *TranslateService

NewTranslateService ***

func (*TranslateService) GetTranslateStatus 

func (o *TranslateService) GetTranslateStatus(fileID int64) (*response.TranslateStatus, error)

GetTranslateStatus 文件转换相关: 获取转换状态 http://static.bimface.com/book/restful/articles/api/translate/get-translate.html

func (*TranslateService) GetTranslateStatusResp 

func (o *TranslateService) GetTranslateStatusResp(fileID int64) (*req.Resp, error)

GetTranslateStatusResp ***

func (*TranslateService) Translate 

func (o *TranslateService) Translate(transRequest *request.TranslateRequest) (*response.TranslateStatus, error)

Translate 文件转换相关: 发起文件转换 http://static.bimface.com/book/restful/articles/api/translate/put-translate.html ** 字段 类型 必填 描述 fileId Number Y 文件Id，即调用上传文件API返回的fileId compressed Boolean N 是否为压缩文件，默认为false rootName String N 如果是压缩文件，必须指定压缩包中哪一个是主文件，例如 root.rvt priority Number 优先级，数字越大，优先级越低 1, 2, 3 callback String N Callback地址，待转换完毕以后，BIMFace会回调该地址 config Json Object N 转换引擎自定义参数，config参数跟转换引擎相关，不同的转换引擎支持不同的config格式。 

例如转换时添加内置材质，则添加参数值{“texture”:true}，
添加外部材质时参考“使用模型外置材质场景”请求报文{“texture”:true}等

**

type UploadService 

type UploadService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

UploadService ***

func NewUploadService 

func NewUploadService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *UploadService

NewUploadService ***

func (*UploadService) DeleteFile 

func (o *UploadService) DeleteFile(fileID int64) (string, error)

DeleteFile 源文件相关: 删除文件 http://static.bimface.com/book/restful/articles/api/file/delete-file.html

func (*UploadService) GetFileList added in v1.0.2 

func (o *UploadService) GetFileList() ([]*response.FileBean, error)

GetFileList 获取文件信息列表 GET https://file.bimface.com/files http://static.bimface.com/restful-apidoc/dist/file.html#_listfilesusingget

func (*UploadService) GetFileMeta added in v1.0.2 

func (o *UploadService) GetFileMeta(fileID int64) (*response.FileBean, error)

GetFileMeta 源文件相关: 获取文件信息 http://static.bimface.com/book/restful/articles/api/file/get-file-metadata.html

func (*UploadService) GetFileUploadStatus added in v1.0.2 

func (o *UploadService) GetFileUploadStatus(fileID int64) (*response.UploadStatus, error)

GetFileUploadStatus GET https://file.bimface.com/files/{fileId}/uploadStatus

func (*UploadService) Upload 

func (o *UploadService) Upload(uploadRequest *request.UploadRequest) (*response.FileBean, error)

Upload 源文件相关: 上传文件 http://static.bimface.com/book/restful/articles/api/file/upload.html ** 字段 类型 必填 描述 示例 name String Y 文件的全名，使用URL编码（UTF-8），最多256个字符 sourceId String N 调用方的文件源ID，不能重复 url String N 文件的下载地址，使用URL编码（UTF-8），最多512个字符，注：在pull方式下必填，必须以http(s)://开头 **

type ViewTokenService 

type ViewTokenService struct {
	AbstractService    //base class
	AccessTokenService *AccessTokenService
}

ViewTokenService ***

func NewViewTokenService 

func NewViewTokenService(serviceClient *utils.ServiceClient, endpoint *config.Endpoint,
	credential *config.Credential, accessTokenService *AccessTokenService) *ViewTokenService

NewViewTokenService ***

func (*ViewTokenService) GrantViewTokenByCompareID 

func (o *ViewTokenService) GrantViewTokenByCompareID(compareID int64) (string, error)

GrantViewTokenByCompareID 根据compareId获取viewToke，然后把viewToken传入JavaScript组件提供的接口中，即可显示工程文件。 注：只有在转换或集成任务成功以后，才能获取viewToken，有效期为12小时。

func (*ViewTokenService) GrantViewTokenByFileID 

func (o *ViewTokenService) GrantViewTokenByFileID(fileID int64) (string, error)

GrantViewTokenByFileID 根据fileId获取viewToke，然后把viewToken传入JavaScript组件提供的接口中，即可显示工程文件。 注：只有在转换或集成任务成功以后，才能获取viewToken，有效期为12小时。

func (*ViewTokenService) GrantViewTokenByIntegrateID 

func (o *ViewTokenService) GrantViewTokenByIntegrateID(integrateID int64) (string, error)

GrantViewTokenByIntegrateID 根据integrateId获取viewToke，然后把viewToken传入JavaScript组件提供的接口中，即可显示工程文件。 注：只有在转换或集成任务成功以后，才能获取viewToken，有效期为12小时。

Source Files

View all Source files

Jump to

Keyboard shortcuts

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