Delete

Functions

OmniClientRequestId omniClientDelete(char const *url, void *userData, OmniClientDeleteCallback callback)

Delete something (file, folder, mount, live object, channel etc..)

OmniClientRequestId omniClientDeleteSingle(char const *url, void *userData, OmniClientDeleteCallback callback)

Delete a file or an empty folder.

OmniClientRequestId omniClientObliterate(char const *url, bool obliterateCheckpoints, void *userData, OmniClientObliterateCallback callback)

Obliterate a path.

OmniClientRequestId omniClientUndelete(char const *url, void *userData, OmniClientUndeleteCallback callback)

Restore a path.

Typedefs

OmniClientDeleteCallback

This is called with the result of omniClientDelete .

OmniClientObliterateCallback

This is called with the result of omniClientObliterate .

OmniClientUndeleteCallback

This is called with the result of omniClientUndelete .

Functions

OmniClientRequestId omniClientDelete(

char const *url,

void *userData,

OmniClientDeleteCallback callback,

)

Delete something (file, folder, mount, live object, channel etc..)

Deleting a folder performs a recursive delete

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 delete

• userData – User data passed to the callback

• callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientDeleteSingle(

char const *url,

void *userData,

OmniClientDeleteCallback callback,

)

Delete a file or an empty folder.

Returns eOmniClientResult_FolderNotEmpty if passed a non-empty folder.

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 file or empty folder to delete

• userData – User data passed to the callback

• callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientObliterate(

char const *url,

bool obliterateCheckpoints,

void *userData,

OmniClientObliterateCallback callback,

)

Obliterate a path.

Doesn’t support recursive removal, doesn’t support wildcards Supports branches / checkpoints Only empty folders can be obliterated

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 obliterate

• obliterateCheckpoints – True to also obliterate checkpoints, false to preserve them

• userData – User data passed to the callback

• callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientUndelete(

char const *url,

void *userData,

OmniClientUndeleteCallback callback,

)

Restore a path.

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 deleted item to restore

• userData – User data passed to the callback

• callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

Typedefs

typedef void (*OmniClientDeleteCallback)(void *userData, OmniClientResult result)

This is called with the result of omniClientDelete.

typedef void (*OmniClientObliterateCallback)(void *userData, OmniClientResult result)

This is called with the result of omniClientObliterate.

typedef void (*OmniClientUndeleteCallback)(void *userData, OmniClientResult result)

This is called with the result of omniClientUndelete.