alias_api.AlReferenceFile

class alias_api.AlReferenceFile

Bases: AlObject

A base class that encapsulates access to Reference File.

copy_wrapper(self: alias_api.AlReferenceFile) → alias_api.AlObject: Return an exact duplicate of this AlReferenceFile wrapper.

delete_object(self: alias_api.AlReferenceFile) → int: Delete the AlReferenceFile from the Alias Universe and return the status of the performed operation.

property file_name: Get the AlReferenceFile file name.

get_alternatives(self: alias_api.AlReferenceFile) → list[AlReferenceFileSet]: Return a list of all the alternatives this AlReferenceFile belongs to.

property name: Get the AlReferenceFile name.

property path: Deprecated - use ‘file_name’ property instead.

property source_path: Deprecated - use ‘source_wirefile’ property instead.

property source_wirefile: Get the AlReferenceFile source wire file path.

status(self: alias_api.AlReferenceFile) → alias_api.ReferenceFileStatus: Return the status of the reference file.

type(self: alias_api.AlReferenceFile) → alias_api.AlObjectType: Return the AlReferenceFile type identifier.

property uuid: Get the AlReferenceFile UUID.