Stat

Enumerations

OmniClientAccessFlags

Access flags.

OmniClientItemFlags

Item flags.

OmniClientListEvent

List Subscribe Event.

OmniClientListIncludeOption

Stat/List Include Options.

Functions

OmniClientRequestId omniClientStat(char const *url, void *userData, OmniClientStatCallback callback)

Retrieve information about a single item. This function is equivalent to omniClientStat2 with eOmniClientListIncludeOption_DefaultNotDeleted.

OmniClientRequestId omniClientStat2(char const *url, OmniClientListIncludeOption includeOption, void *userData, OmniClientStatCallback callback)

Retrieve information about a single item.

OmniClientRequestId omniClientStatSubscribe(char const *url, void *userData, OmniClientStatCallback callback, OmniClientStatSubscribeCallback subscribeCallback)

Retrieve information about a single item, and subscribe to future changes. This function is equivalent to omniClientStatSubscribe2 with eOmniClientListIncludeOption_DefaultNotDeleted.

OmniClientRequestId omniClientStatSubscribe2(char const *url, OmniClientListIncludeOption includeOption, void *userData, OmniClientStatCallback callback, OmniClientStatSubscribeCallback subscribeCallback)

Retrieve information about a single item, and subscribe to future changes.

Structs

OmniClientListEntry

List entry containing information about a file or folder.

Typedefs

OmniClientStatCallback

This is called with the results of omniClientStat or omniClientStatSubscribe .

OmniClientStatSubscribeCallback

This is called any time an item you've subscribed to with omniClientStatSubscribe changes.

Enumerations

enum OmniClientAccessFlags

Access flags.

Values:

enumerator fOmniClientAccess_Read

Can read this thing.

enumerator fOmniClientAccess_Write

Can write to this thing.

enumerator fOmniClientAccess_Admin

Can change ACLs for this thing.

enumerator fOmniClientAccess_Full

read + write + admin

enum OmniClientItemFlags

Item flags.

Values:

enumerator fOmniClientItem_ReadableFile

You can call omniClientReadFile on this.

Note

: ACLs may still prevent you from reading it

enumerator fOmniClientItem_WriteableFile

You can call omniClientWriteFile on this.

Note

ACLs may still prevent you from writing it

enumerator fOmniClientItem_CanHaveChildren

This thing can contain other things (a folder-like thing)

enumerator fOmniClientItem_DoesNotHaveChildren

This thing does not have any children.

The lack of this flag does not mean it does have children! Sometimes we are not sure if it has children until you attempt to list the children. This is only intended to be used for UI elements to hide the “expand” button if we are sure it does not have any children.

enumerator fOmniClientItem_IsMount

This thing is the root of a mount point.

enumerator fOmniClientItem_IsInsideMount

This thing is located inside a mounted folder.

enumerator fOmniClientItem_CanLiveUpdate

This thing supports live updates.

enumerator fOmniClientItem_IsOmniObject

This thing is in omni-object format.

You must use omniClientLiveRead to read it and omniClientLiveUpdate to update it

enumerator fOmniClientItem_IsChannel

You can call omniClientJoinChannel on this.

enumerator fOmniClientItem_IsCheckpointed

This item is a checkpoint.

enumerator fOmniClientItem_IsDeleted

This item is deleted - never set if the server does not support soft-delete.

enum OmniClientListEvent

List Subscribe Event.

Values:

enumerator eOmniClientListEvent_Unknown

Unknown event.

enumerator eOmniClientListEvent_Created

An item was created.

enumerator eOmniClientListEvent_Updated

An item (contents) were updated.

enumerator eOmniClientListEvent_Deleted

An item was deleted.

enumerator eOmniClientListEvent_Metadata

An item’s metadata was changed.

enumerator eOmniClientListEvent_Locked

A file was locked.

enumerator eOmniClientListEvent_Unlocked

A file was unlocked.

enumerator eOmniClientListEvent_Obliterated

A file was obliterated.

enumerator Count_eOmniClientListEvent

enum OmniClientListIncludeOption

Stat/List Include Options.

Values:

enumerator eOmniClientListIncludeOption_DefaultNotDeleted

List only files which are not deleted.

enumerator eOmniClientListIncludeOption_IncludeDeleted

List both files which are deleted and files which are not deleted.

enumerator eOmniClientListIncludeOption_OnlyDeleted

List only files which are deleted.

Functions

OmniClientRequestId omniClientStat(

char const *url,

void *userData,

OmniClientStatCallback callback,

)

Retrieve information about a single item. This function is equivalent to omniClientStat2 with eOmniClientListIncludeOption_DefaultNotDeleted.

This works on both files and folders The “relativePath” in the entry is blank

Note

If this function is called after omniClientShutdown, kInvalidRequestId will be returned, and the callback will not be called.

Parameters:

• url – The URL of the item to get information about

• userData – User data passed to the callback

• callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientStat2(

char const *url,

OmniClientListIncludeOption includeOption,

void *userData,

OmniClientStatCallback callback,

)

Retrieve information about a single item.

This works on both files and folders The “relativePath” in the entry is blank

Note

If this function is called after omniClientShutdown, kInvalidRequestId will be returned, and the callback will not be called.

Parameters:

• url – The URL of the item to get information about

• includeOption – Controls whether deleted items are included in the results

• userData – User data passed to the callback

• callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientStatSubscribe(

char const *url,

void *userData,

OmniClientStatCallback callback,

OmniClientStatSubscribeCallback subscribeCallback,

)

Retrieve information about a single item, and subscribe to future changes. This function is equivalent to omniClientStatSubscribe2 with eOmniClientListIncludeOption_DefaultNotDeleted.

Note

If this function is called after omniClientShutdown, kInvalidRequestId will be returned, and the callback will not be called.

Parameters:

• url – The URL of the item to get information about and subscribe to

• userData – User data passed to the callbacks

• callback – The callback function for the initial stat result

• subscribeCallback – The callback function for subscription updates

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientStatSubscribe2(

char const *url,

OmniClientListIncludeOption includeOption,

void *userData,

OmniClientStatCallback callback,

OmniClientStatSubscribeCallback subscribeCallback,

)

Retrieve information about a single item, and subscribe to future changes.

Note

If this function is called after omniClientShutdown, kInvalidRequestId will be returned, and the callback will not be called.

Parameters:

• url – The URL of the item to get information about and subscribe to

• includeOption – Controls whether deleted items are included in the results

• userData – User data passed to the callbacks

• callback – The callback function for the initial stat result

• subscribeCallback – The callback function for subscription updates

Returns:

A request ID that can be used with omniClientStop

Typedefs

typedef void (*OmniClientStatCallback)(void *userData, OmniClientResult result, struct OmniClientListEntry const *entry)

This is called with the results of omniClientStat or omniClientStatSubscribe.

typedef void (*OmniClientStatSubscribeCallback)(void *userData, OmniClientResult result, OmniClientListEvent listEvent, struct OmniClientListEntry const *entry)

This is called any time an item you’ve subscribed to with omniClientStatSubscribe changes.