IEDMS_LibraryService interface

No description yet.

public interface IEDMS_LibraryService

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
AddOrUpdateTag	bool
AddToMyLibrary	bool
CreateItem	bool
CreateSimpleParameter	IEDMS_SimpleParameter
CreateSimpleParameters	IEDMS_SimpleParameters
CreateTag	IEDMS_Tag
CreateTags	IEDMS_Tags
ExecuteJsonRequestToCiiva	bool
ExecuteJsonRequestToOctopart	bool
ExecuteJsonRequestToOctopartExt	bool
GetItems	bool
GetTags	bool
GetTagsByRevisionId	bool
RemoveFromMyLibrary	bool
RemoveItem	bool
RemoveTags	bool
UpdateItemTags	bool

AddOrUpdateTag

No description yet.

bool AddOrUpdateTag(IEDMS_Tag argTag, out IEDMS_Tag argResultTag, out string argErrorMsg);
bool AddOrUpdateTag(object argTag, out IEDMS_Tag argResultTag, out string argErrorMsg);

Parameter	Type	Passing
argTag	IEDMS_Tag	value
argResultTag	IEDMS_Tag	out
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_LibraryServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

AddToMyLibrary

No description yet.

bool AddToMyLibrary(string argLibraryItemID, out string argErrorMsg);

Parameter	Type	Passing
argLibraryItemID	string	value
argErrorMsg	string	out

Returns: bool

CreateItem

No description yet.

bool CreateItem(string argRevisionId, out IEDMS_LibraryItem argItem, out string argErrorMsg);

Parameter	Type	Passing
argRevisionId	string	value
argItem	IEDMS_LibraryItem	out
argErrorMsg	string	out

Returns: bool

CreateSimpleParameter

No description yet.

IEDMS_SimpleParameter CreateSimpleParameter();

Returns: IEDMS_SimpleParameter

Extension method of IEDMS_LibraryServiceHelper (using DXP;).

CreateSimpleParameters

No description yet.

IEDMS_SimpleParameters CreateSimpleParameters();

Returns: IEDMS_SimpleParameters

Extension method of IEDMS_LibraryServiceHelper (using DXP;).

CreateTag

No description yet.

IEDMS_Tag CreateTag();

Returns: IEDMS_Tag

Extension method of IEDMS_LibraryServiceHelper (using DXP;).

CreateTags

No description yet.

IEDMS_Tags CreateTags();

Returns: IEDMS_Tags

Extension method of IEDMS_LibraryServiceHelper (using DXP;).

ExecuteJsonRequestToCiiva

No description yet.

bool ExecuteJsonRequestToCiiva(string argEndPointName, string argRequest, out string argResponse, out string argErrorMsg);

Parameter	Type	Passing
argEndPointName	string	value
argRequest	string	value
argResponse	string	out
argErrorMsg	string	out

Returns: bool

ExecuteJsonRequestToOctopart

No description yet.

bool ExecuteJsonRequestToOctopart(string argEndPointName, IEDMS_SimpleParameters argParamList, out string argResponse, out string argErrorMsg);
bool ExecuteJsonRequestToOctopart(string argEndPointName, object argParamList, out string argResponse, out string argErrorMsg);

Parameter	Type	Passing
argEndPointName	string	value
argParamList	IEDMS_SimpleParameters	value
argResponse	string	out
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_LibraryServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

ExecuteJsonRequestToOctopartExt

No description yet.

bool ExecuteJsonRequestToOctopartExt(string argEndPointName, string argRequest, out string argResponse, out string argErrorMsg);

Parameter	Type	Passing
argEndPointName	string	value
argRequest	string	value
argResponse	string	out
argErrorMsg	string	out

Returns: bool

GetItems

No description yet.

bool GetItems(out IEDMS_LibraryItems argItems, out string argErrorMsg);

Parameter	Type	Passing
argItems	IEDMS_LibraryItems	out
argErrorMsg	string	out

Returns: bool

GetTags

No description yet.

bool GetTags(out IEDMS_Tags argTags, out string argErrorMsg);

Parameter	Type	Passing
argTags	IEDMS_Tags	out
argErrorMsg	string	out

Returns: bool

GetTagsByRevisionId

No description yet.

bool GetTagsByRevisionId(string argRevisionID, out IEDMS_Tags argTags, out string argErrorMsg);

Parameter	Type	Passing
argRevisionID	string	value
argTags	IEDMS_Tags	out
argErrorMsg	string	out

Returns: bool

RemoveFromMyLibrary

No description yet.

bool RemoveFromMyLibrary(string argLibraryItemID, out string argErrorMsg);

Parameter	Type	Passing
argLibraryItemID	string	value
argErrorMsg	string	out

Returns: bool

RemoveItem

No description yet.

bool RemoveItem(string argRevisionId, out string argErrorMsg);

Parameter	Type	Passing
argRevisionId	string	value
argErrorMsg	string	out

Returns: bool

RemoveTags

No description yet.

bool RemoveTags(IEDMS_Tags argTags, out string argErrorMsg);
bool RemoveTags(object argTags, out string argErrorMsg);

Parameter	Type	Passing
argTags	IEDMS_Tags	value
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_LibraryServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

UpdateItemTags

No description yet.

bool UpdateItemTags(string argLibraryItemID, IEDMS_Tags argTags, out string argErrorMsg);
bool UpdateItemTags(string argLibraryItemID, object argTags, out string argErrorMsg);

Parameter	Type	Passing
argLibraryItemID	string	value
argTags	IEDMS_Tags	value
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_LibraryServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

Returned by

IEDMS_DXPServerManager.GetLibraryService