FileDescriptor Complex Type

  • Article

Applies to: SharePoint Workspace 2010 | Visual Studio 2008

The FileDescriptor type is the web service representation of the metadata associated with a file or folder. For example, the file name and size is part of the FileDescriptor.

Syntax

<FileDescriptor>
  <ID />
  <URI />
  <CreatedBy />
  <ModifiedBy />
  <Created />
  <Modified />
  <FolderID />
  <Unread />
  <Name />
  <DisplayName />
  <Type />
  <Size />
  <LaunchURL />
  <DownloadState />
  <AutoDownload />
  <DownloadSizeLimit />
  <Count/>
</FileDescriptor>

Complex Type Elements

Element

Data type

Description

ID

xs:string

Files Tool ID. For the root folder of the Files tool, the ID is "$ComponentGroup".

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Import operation: value ignored by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

URI

xs:anyURI

URI that allows access to the file or folder (read-only). This URI can be used to build a HTTP Post URL that targets the file or folder. You can use a Post URL that targets a file or folder in other GrooveFilesBase64 operations.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Import operation: value ignored by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

CreatedBy

xs:anyURI

Identity URL of Groove user who created the file or folder (read-only). You can use an Identity URL to send a message or invitation to the Groove user (GrooveLocal Web Service) or to find the VCard information for the Groove user (GrooveContacts Web Service and GrooveVCard Web Service).

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Import operation: value ignored by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

ModifiedBy

xs:anyURI

Identity URL of Groove user who updated the file or folder (read-only).

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Import operation: value ignored by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

Created

xs:dateTime

Date-time when the file or folder was created (read-only). Specified as a UTC date-time with a precision of milliseconds.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Import operation: value ignored by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

Modified

xs:dateTime

Date-time when the file or folder was last changed (read-only). Specified as a UTC date-time with a precision of milliseconds.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Import operation: value ignored by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

FolderID

xs:string

Identifies the folder that contains this file or folder. The FolderID is the Files Tool ID of the parent folder. Files in the root folder of the Files tool have a FolderID of "$ComponentGroup", which is the ID of the root folder. The root folder has a FolderID equal to the empty string.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value required by operation.

  • Import operation: value required by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

Unread

xs:boolean

Specifies "true" if the file or folder has not been read and "false" if it has been read.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Import operation: value ignored by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

Name

xs:string

The file name. For the top-level folder of the Files tool, the name is "$ComponentGroup".

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value required by operation. The Name element determines the file extension, but any name specified is overridden by the DisplayName value.

  • Import operation: value required by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

DisplayName

xs:string

The file name without the file extension. For the top-level folder of the Files tool, the display name is "$ComponentGroup".

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value required by operation.

  • Import operation: value ignored by operation.

  • UpdateFile operation: value required by operation.

  • Events: value provided by events.

Type

xs:string

Specifies whether the object is a file (Type is "File") or folder (Type is Folder").

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value required by operation

  • Import operation: value ignored by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

Size

xs:int

Specifies the size of the file in bytes (read-only). If the object is a folder, it has a size of 0.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Import operation: value ignored by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

LaunchURL

xs:anyURI

Provides the URI needed to launch (execute) the file with the GrooveLocal.LaunchFile operation. Specify the URI provided in this parameter in the FileURI parameter in LaunchFile.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Import operation: value ignored by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

DownloadState

xs:int

Specifies the current download state of the file: 1 (local), 2 (remote), 3 (in process of downloading), or 4 (download attempted, but encountered an error).

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Import operation: value ignored by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

AutoDownload

xs:boolean

The AutoDownload element is only meaningful for folders; if true, Groove automatically downloads a file when it is added to the folder.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value required by operation.

  • Import operation: value required by operation.

  • UpdateFile operation: value required by operation.

  • Events: value provided by events.

DownloadSizeLimit

xs:int

The DownloadSizeLimit is only meaningful for folders; it specifies the maximum size in bytes of a file that will be automatically downloaded. A remote file of any size can be downloaded explicitly with the Download operation. If there is no value for DownloadSizeLimit, then any size file will be automatically downloaded. Note that the Forms tool user interface displays this value in MB, but the element is stored in bytes.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value required by operation.

  • Import operation: value required by operation.

  • UpdateFile operation: value required by operation.

  • Events: value provided by events.

Count

xs:int

Number of files and folders stored in a folder.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Import operation: value ignored by operation.

  • UpdateFile operation: value ignored by operation.

  • Events: value provided by events.

See Also

Reference

GrooveFilesBase64 Web Service