vmware::content::library::item::File Interface Reference

The File interface can be used to query for information on the files within a library item. More...

Inherited by vmware::content::library::item::FileStub.

List of all members.

Public Member Functions
vmware.content.library.item.FileTypes.Info	Get (string libraryItemId, string name)
	Retrieves the information for a single file in a library item by its name.
vmware.content.library.item.FileTypes.Info	Get (string libraryItemId, string name, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Retrieves the information for a single file in a library item by its name.
global::System.Threading.Tasks.Task < vmware.content.library.item.FileTypes.Info >	GetAsync (string libraryItemId, string name)
	Retrieves the information for a single file in a library item by its name.
global::System.Threading.Tasks.Task < vmware.content.library.item.FileTypes.Info >	GetAsync (string libraryItemId, string name, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Retrieves the information for a single file in a library item by its name.
global::System.Collections.Generic.List < vmware.content.library.item.FileTypes.Info >	List (string libraryItemId)
	Lists all of the files that are stored within a given library item.
global::System.Collections.Generic.List < vmware.content.library.item.FileTypes.Info >	List (string libraryItemId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Lists all of the files that are stored within a given library item.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.content.library.item.FileTypes.Info > >	ListAsync (string libraryItemId)
	Lists all of the files that are stored within a given library item.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.content.library.item.FileTypes.Info > >	ListAsync (string libraryItemId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Lists all of the files that are stored within a given library item.

---

Detailed Description

The File interface can be used to query for information on the files within a library item.

Files are objects which are added to a library item through the UpdateSession and updatesession.File interfaces.

---

Member Function Documentation

vmware.content.library.item.FileTypes.Info vmware::content::library::item::File::Get	(	string	libraryItemId,
		string	name
	)

Retrieves the information for a single file in a library item by its name.

Exceptions:

vmware.vapi.std.errors.NotFound	if libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.NotFound	if name refers to a file that does not exist in the library item.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .

Parameters:

libraryItemId	Identifier of the library item whose file information should be returned. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
name	Name of the file in the library item whose information should be returned.

Returns:

The File.Info object with information on the specified file.

Implemented in vmware::content::library::item::FileStub.

vmware.content.library.item.FileTypes.Info vmware::content::library::item::File::Get	(	string	libraryItemId,
		string	name,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Retrieves the information for a single file in a library item by its name.

Exceptions:

vmware.vapi.std.errors.NotFound	if libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.NotFound	if name refers to a file that does not exist in the library item.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .

Parameters:

libraryItemId	Identifier of the library item whose file information should be returned. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
name	Name of the file in the library item whose information should be returned.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

The File.Info object with information on the specified file.

Implemented in vmware::content::library::item::FileStub.

global::System.Threading.Tasks.Task<vmware.content.library.item.FileTypes.Info> vmware::content::library::item::File::GetAsync	(	string	libraryItemId,
		string	name,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Retrieves the information for a single file in a library item by its name.

Exceptions:

vmware.vapi.std.errors.NotFound	if libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.NotFound	if name refers to a file that does not exist in the library item.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .

Parameters:

libraryItemId	Identifier of the library item whose file information should be returned. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
name	Name of the file in the library item whose information should be returned.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

The File.Info object with information on the specified file.

Implemented in vmware::content::library::item::FileStub.

global::System.Threading.Tasks.Task<vmware.content.library.item.FileTypes.Info> vmware::content::library::item::File::GetAsync	(	string	libraryItemId,
		string	name
	)

Retrieves the information for a single file in a library item by its name.

Exceptions:

vmware.vapi.std.errors.NotFound	if libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.NotFound	if name refers to a file that does not exist in the library item.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .

Parameters:

libraryItemId	Identifier of the library item whose file information should be returned. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
name	Name of the file in the library item whose information should be returned.

Returns:

The File.Info object with information on the specified file.

Implemented in vmware::content::library::item::FileStub.

global::System.Collections.Generic.List<vmware.content.library.item.FileTypes.Info> vmware::content::library::item::File::List

(

string

libraryItemId

)

Lists all of the files that are stored within a given library item.

Exceptions:

vmware.vapi.std.errors.NotFound	if libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .

Parameters:

libraryItemId

Identifier of the library item whose files should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .

Returns:

The list of all of the files that are stored within the given library item.

Implemented in vmware::content::library::item::FileStub.

global::System.Collections.Generic.List<vmware.content.library.item.FileTypes.Info> vmware::content::library::item::File::List	(	string	libraryItemId,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Lists all of the files that are stored within a given library item.

Exceptions:

vmware.vapi.std.errors.NotFound	if libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .

Parameters:

libraryItemId	Identifier of the library item whose files should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

The list of all of the files that are stored within the given library item.

Implemented in vmware::content::library::item::FileStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.content.library.item.FileTypes.Info> > vmware::content::library::item::File::ListAsync	(	string	libraryItemId,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Lists all of the files that are stored within a given library item.

Exceptions:

vmware.vapi.std.errors.NotFound	if libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .

Parameters:

libraryItemId	Identifier of the library item whose files should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

The list of all of the files that are stored within the given library item.

Implemented in vmware::content::library::item::FileStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.content.library.item.FileTypes.Info> > vmware::content::library::item::File::ListAsync

(

string

libraryItemId

)

Lists all of the files that are stored within a given library item.

Exceptions:

vmware.vapi.std.errors.NotFound	if libraryItemId refers to a library item that does not exist.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read .

Parameters:

libraryItemId

Identifier of the library item whose files should be listed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .

Returns:

The list of all of the files that are stored within the given library item.

Implemented in vmware::content::library::item::FileStub.

---

The documentation for this interface was generated from the following file:

• File.cs