From Forum Post: https://forums.developer.nvidia.com/t/omniverse-client-library-python-module-documentation/191055

The Omniverse Client Library has Python bindings that we use in the helloWorld.py sample. If you run help(omni.client) you’ll get some nice documentation. Here are the docs for 1.13.19:


NAME

    omni.client



PACKAGE CONTENTS

    _omniclient



FUNCTIONS

    break_url(...) method of builtins.PyCapsule instance

        break_url(arg0: str) -> omni.client._omniclient.Url

    

    combine_urls(...) method of builtins.PyCapsule instance

        combine_urls(arg0: str, arg1: str) -> str

    

    combine_with_base_url(...) method of builtins.PyCapsule instance

        combine_with_base_url(arg0: str) -> str

    

    copy(src_url: str, dst_url: str, behavior: omni.client._omniclient.CopyBehavior = CopyBehavior.ERROR_IF_EXISTS) -> omni.client._omniclient.Result

        Synchronously copy a thing from ``src_url`` to ``dst_url``. **(Blocking version.)**

        

            The thing can be anything that supports copying (files, folders, etc..)

            If both src and dst are on the same server, this is done on the server

            Otherwise the file is first downloaded from 'src' then uploaded to 'dst'

            Destination folders will be created as needed

        

        Args:

            src_url (str): Source url.

            dst_url (str): Destination url.

            behavior (omni.client.CopyBehavior, default:ERROR_IF_EXISTS): behavior if the destination exists.

        

        Returns:

            (omni.client.Result): Result.

    

    copy_async(src_url: str, dst_url: str, behavior: omni.client._omniclient.CopyBehavior = CopyBehavior.ERROR_IF_EXISTS) -> omni.client._omniclient.Result

        Asynchronously copy a thing from ``src_url`` to ``dst_url``. **(Coroutine version.)**

        

            The thing can be anything that supports copying (files, folders, etc..)

            If both src and dst are on the same server, this is done on the server

            Otherwise the file is first downloaded from 'src' then uploaded to 'dst'

            Destination folders will be created as needed

        

        Args:

            src_url (str): Source url.

            dst_url (str): Destination url.

            behavior (omni.client.CopyBehavior, default:ERROR_IF_EXISTS): behavior if the destination exists.

        

        Returns:

            (omni.client.Result): Result.

    

    copy_with_callback(...) method of builtins.PyCapsule instance

        copy_with_callback(src_url: str, dst_url: str, callback: Callable[[omni.client._omniclient.Result], None], behavior: omni.client._omniclient.CopyBehavior = CopyBehavior.ERROR_IF_EXISTS) -> omni.client._omniclient.Request

        

        

        

        Asynchronously copy a thing from ``src_url`` to ``dst_url``. **(Callback version.)**

        

         The thing can be anything that supports copying (files, folders, etc..)

         If both src and dst are on the same server, this is done on the server

         Otherwise the file is first downloaded from 'src' then uploaded to 'dst'

         Destination folders will be created as needed

        

        Args:

            src_url (str): Source url.

            dst_url (str): Destination url.

            callback (Callable[omni.client.Result]): Callback to be called with the result.

            behavior (omni.client.CopyBehavior, default:ERROR_IF_EXISTS): behavior if the destination exists.

        

        Returns:

            (omni.client.Request): Request object.

    

    create_checkpoint(url: str, comment: str, force: bool = False) -> omni.client._omniclient.Result

        Synchronously create a checkpoint. **(Blocking version.)**

        

        Args:

            url (str): Url.

            comment (str): Comment to associate with the checkpoint

            force (bool): Set to true to force creating a checkpoint even if there are no changes

        

        Returns:

            (Tuple[omni.client.Result, CheckpointQuery]): Result and query that can be used to refer to this checkpoint

    

    create_checkpoint_async(url: str, comment: str, force: bool = False) -> omni.client._omniclient.Result

        Asynchronously create a checkpoint. **(Coroutine version.)**

        

        Args:

            url (str): Url.

            comment (str): Comment to associate with the checkpoint

            force (bool): Set to true to force creating a checkpoint even if there are no changes

        

        Returns:

            (Tuple[omni.client.Result, CheckpointQuery]): Result and query that can be used to refer to this checkpoint

    

    create_checkpoint_with_callback(...) method of builtins.PyCapsule instance

        create_checkpoint_with_callback(url: str, comment: str, force: bool = False, callback: Callable[[omni.client._omniclient.Result, str], None]) -> omni.client._omniclient.Request

        

        

        

        Asynchronously create a checkpoint. **(Callback version.)**

        

        Args:

            url (str): Url.

            comment (str): Comment to associate with the checkpoint

            force (bool): Set to true to force creating a checkpoint even if there are no changes

            callback (Callable[omni.client.Result, CheckpointQuery]): Callback to be called with the result.

        

        Returns:

            (omni.client.Request): Request object.

    

    create_folder(url: str) -> omni.client._omniclient.Result

        Synchronously create a folder. **(Blocking version.)**

        

        Args:

            url (str): Url.

        

        Returns:

            (omni.client.Result): Result.

    

    create_folder_async(url: str) -> omni.client._omniclient.Result

        Asynchronously create a folder. **(Coroutine version.)**

        

        Args:

            url (str): Url.

        

        Returns:

            (omni.client.Result): Result.

    

    create_folder_with_callback(...) method of builtins.PyCapsule instance

        create_folder_with_callback(url: str, callback: Callable[[omni.client._omniclient.Result], None]) -> omni.client._omniclient.Request

        

        

        

        Asynchronously create a folder. **(Callback version.)**

        

        Args:

            url (str): Url.

            callback (Callable[omni.client.Result]): Callback to be called with the result.

        

        Returns:

            (omni.client.Request): Request object.

    

    delete(url: str) -> omni.client._omniclient.Result

        Synchronously delete something (file, folder, mount, liveFile, channel etc..). **(Blocking version.)**

        

        Args:

            url (str): Url.

        

        Returns:

            (omni.client.Result): Result.

    

    delete_async(url: str) -> omni.client._omniclient.Result

        Asynchronously delete something (file, folder, mount, liveFile, channel etc..). **(Coroutine version.)**

        

        Args:

            url (str): Url.

        

        Returns:

            (omni.client.Result): Result.

    

    delete_with_callback(...) method of builtins.PyCapsule instance

        delete_with_callback(url: str, callback: Callable[[omni.client._omniclient.Result], None]) -> omni.client._omniclient.Request

        

        

        Asynchronously delete something (file, folder, mount, liveFile, channel etc..). **(Callback version.)**

        

        Args:

            url (str): Url.

            callback (Callable[omni.client.Result]): Callback to be called with the result.

        

        Returns:

            (omni.client.Request): Request object.

    

    get_acls(url: str) -> Tuple[omni.client._omniclient.Result, List[omni.client._omniclient.AclEntry]]

        Get the ACL's (permissions lists) on a folder/file. **(Blocking version.)**

        

        Args:

            url (str): Url.

            callback (Callable[omni.client.Result, List[AclEntry]): Callback to be called with the result and current ACLs.

        

        Returns:

            (omni.client.Request): Request object.

    

    get_acls_async(url: str) -> Tuple[omni.client._omniclient.Result, List[omni.client._omniclient.AclEntry]]

        "Get the ACL's (permissions lists) on a folder/file.  **(Coroutine version.)**

        

        Args:

            url (str): Url.

            callback (Callable[omni.client.Result, List[AclEntry]): Callback to be called with the result and current ACLs.

        

        Returns:

            (omni.client.Request): Request object.

    

    get_acls_with_callback(...) method of builtins.PyCapsule instance

        get_acls_with_callback(url: str, callback: Callable[[omni.client._omniclient.Result, list], None]) -> omni.client._omniclient.Request

        

        

        

        Asynchronously get the ACL's on a folder/file. **(Callback version.)**

        

        Args:

            url (str): Url.

            callback (Callable[omni.client.Result, List[AclEntry]): Callback to be called with the result and current ACLs.

        

        Returns:

            (omni.client.Request): Request object.

    

    get_branch_and_checkpoint_from_query(...) method of builtins.PyCapsule instance

        get_branch_and_checkpoint_from_query(arg0: str) -> tuple

    

    get_log_level(...) method of builtins.PyCapsule instance

        get_log_level(arg0: omni.client._omniclient.LogLevel) -> str

    

    get_server_info(url: str) -> Tuple[omni.client._omniclient.Result, omni.client._omniclient.ServerInfo]

        Get server info by url (blocking version).

    

    get_server_info_async(url: str) -> Tuple[omni.client._omniclient.Result, omni.client._omniclient.ServerInfo]

        Get server info by url (async version).

    

    get_server_info_with_callback(...) method of builtins.PyCapsule instance

        get_server_info_with_callback(arg0: str, arg1: Callable[[omni.client._omniclient.Result, omni.client._omniclient.ServerInfo], None]) -> omni.client._omniclient.Request

    

    get_version(...) method of builtins.PyCapsule instance

        get_version() -> str

    

    initialize(...) method of builtins.PyCapsule instance

        initialize(version: int = 281530811285523) -> bool

    

    join_channel_with_callback(...) method of builtins.PyCapsule instance

        join_channel_with_callback(url: str, callback: Callable[[omni.client._omniclient.Result, omni.client._omniclient.ChannelEvent, str, omni.client._omniclient.Content], None]) -> omni.client._omniclient.Request

        

        

        

        Asynchronously join a channel. **(Callback version.)**

        

        Args:

            url (str): Url.

            callback (Callable[omni.client.Result, omni.client.ChannelEvent, str, omni.client.Content]): Callback to be called with the result.

        

        Returns:

            (omni.client.Request): Request object.

    

    list(url: str) -> Tuple[omni.client._omniclient.Result, Tuple[omni.client._omniclient.ListEntry]]

        Synchronously list content of a folder. **(Blocking version.)**

        

        Args:

            url (str): Url.

        Returns:

            (Tuple[Result, Tuple[omni.client.ListEntry]]]): Result and tuple of entries.

    

    list_async(url: str) -> Tuple[omni.client._omniclient.Result, Tuple[omni.client._omniclient.ListEntry]]

        Asynchronously list content of a folder. **(Coroutine version.)**

        

        Args:

            url (str): Url.

        Returns:

            (Tuple[Result, Tuple[omni.client.ListEntry]]]): Result and tuple of entries.

    

    list_checkpoints(url: str) -> Tuple[omni.client._omniclient.Result, Tuple[omni.client._omniclient.ListEntry]]

        Synchronously list checkpoints of a file. **(Blocking version.)**

        

        Args:

            url (str): Url.

        Returns:

            (Tuple[Result, Tuple[omni.client.ListEntry]]]): Result and tuple of entries.

    

    list_checkpoints_async(url: str) -> Tuple[omni.client._omniclient.Result, Tuple[omni.client._omniclient.ListEntry]]

        Asynchronously list checkpoints of a file. **(Coroutine version.)**

        

        Args:

            url (str): Url.

        Returns:

            (Tuple[Result, Tuple[omni.client.ListEntry]]]): Result and tuple of entries.

    

    list_checkpoints_with_callback(...) method of builtins.PyCapsule instance

        list_checkpoints_with_callback(url: str, callback: Callable[[omni.client._omniclient.Result, tuple], None]) -> omni.client._omniclient.Request

        

        

        

        Asynchronously list checkpoints. **(Callback version.)**

        

        Args:

            url (str): Url.

            callback (Callable[omni.client.Result, Tuple[omni.client.ListEntry]]): Callback to be called with the result.

        

        Returns:

            (omni.client.Request): Request object.

    

    list_subscribe_with_callback(...) method of builtins.PyCapsule instance

        list_subscribe_with_callback(url: str, list_callback: Callable[[omni.client._omniclient.Result, tuple], None], subscribe_callback: Callable[[omni.client._omniclient.Result, omni.client._omniclient.ListEvent, omni.client._omniclient.ListEntry], None]) -> omni.client._omniclient.Subscription

        

        

        Subscribe to change notifications for a url. **(Callback version.)**

        If 'url' is a file, you will only receive information about that file.

        If 'url' is a folder, you will additionally receive information about the files inside it.

        '`list_callback` is called once with the initial list,then '`subscribe_callback`' may be called multiple times after that as items change.

        

        Args:

            url (str): Url.

            list_callback(Callable[Result, Tuple[omni.client.ListEntry]]): Callback to be called once with the list.

            subscribe_callback(Callable[Result, omni.client.ListEvent, omni.client.ListEntry]): Callback to be called when changes happen.

        

        Returns:

            Subscrption holder (`Subscription`).

    

    list_with_callback(...) method of builtins.PyCapsule instance

        list_with_callback(url: str, callback: Callable[[omni.client._omniclient.Result, tuple], None]) -> omni.client._omniclient.Request

        

        

        Asynchronously list content of a folder. **(Callback version.)**

        

        Args:

            url (str): Url.

            callback(Callable[Result, Tuple[omni.client.ListEntry]]): Callback to be called with the results.

        

        Returns:

            (omni.client.Request): Request object.

    

    lock_with_callback(...) method of builtins.PyCapsule instance

        lock_with_callback(arg0: str, arg1: Callable[[omni.client._omniclient.Result], None]) -> omni.client._omniclient.Request

        

        

        

        Lock a URL so only this client can modify it. **(Callback version.)**

        

        Args:

            url (str): URL.

    

    make_file_url(...) method of builtins.PyCapsule instance

        make_file_url(arg0: str) -> str

    

    make_query_from_branch_and_checkpoint(...) method of builtins.PyCapsule instance

        make_query_from_branch_and_checkpoint(arg0: str, arg1: int) -> str

    

    make_relative_url(...) method of builtins.PyCapsule instance

        make_relative_url(arg0: str, arg1: str) -> str

    

    make_url(...) method of builtins.PyCapsule instance

        make_url(scheme: str = None, user: str = None, host: str = None, port: str = None, path: str = None, query: str = None, fragment: str = None) -> str

    

    normalize_url(...) method of builtins.PyCapsule instance

        normalize_url(arg0: str) -> str

    

    pop_base_url(...) method of builtins.PyCapsule instance

        pop_base_url(arg0: str) -> bool

    

    push_base_url(...) method of builtins.PyCapsule instance

        push_base_url(arg0: str) -> None

    

    read_file(url: str) -> Tuple[omni.client._omniclient.Result, str, omni.client._omniclient.Content]

        Read a file. **(Blocking version.)**

        

        Args:

            url (str): Url.

        

        Returns:

            (Tuple[omni.client.Result, str, omni.client.Content]): Result, version and content.

    

    read_file_async(url: str) -> Tuple[omni.client._omniclient.Result, str, omni.client._omniclient.Content]

        Asynchronously read a file. **(Coroutine version.)**

        

        Args:

            url (str): Url.

        

        Returns:

            (Tuple[omni.client.Result, str, omni.client.Content]): Result, version and content.

    

    read_file_with_callback(...) method of builtins.PyCapsule instance

        read_file_with_callback(url: str, callback: Callable[[omni.client._omniclient.Result, str, omni.client._omniclient.Content], None]) -> omni.client._omniclient.Request

        

        

        

        Asynchronously read a file. **(Callback version.)**

        

        Args:

            url (str): Url.

            callback (Callable[omni.client.Result, omni.client.Content]): Callback to be called with the result.

        

        Returns:

            (omni.client.Request): Request object.

    

    reconnect(...) method of builtins.PyCapsule instance

        reconnect(arg0: str) -> None

        

        

        Attempt to connect to a specific url

        

        Args:

            url (str): Attempt to connect to this url

    

    register_authorize_callback(...) method of builtins.PyCapsule instance

        register_authorize_callback(arg0: Callable[[str], object]) -> omni.client._omniclient.Subscription

        

        

        Set authorize callback.

        

        The callback receives the URL prefix (such as "scheme://server:port") as a parameter and should return either:

            None or False: Continue to the next authorize callback (or default authorization method)

            True: Abort the connection

            String: A token (usually the auth_token provided by get_server_info)

            (String, String): A username and password

        

        Args:

            callback (Callable[UrlPrefix]): Callback to be called to provide authentication information.

        

        Returns:

            (omni.client.Subscription): Subscription Object. Callback will be unregistered once subcription is released.

    

    register_connection_status_callback(...) method of builtins.PyCapsule instance

        register_connection_status_callback(arg0: Callable[[str, omni.client._omniclient.ConnectionStatus], None]) -> omni.client._omniclient.Subscription

        

        

        Register connection status callback.

        

        Args:

            callback (Callable[ServerUrl, OmniClientFileStatus]): Callback to be called with the status.

        

        Returns:

            (omni.client.Subscription): Subscription Object. Callback will be unregistered once subcription is released.

    

    register_file_status_callback(...) method of builtins.PyCapsule instance

        register_file_status_callback(arg0: Callable[[str, omni.client._omniclient.FileStatus, int], None]) -> omni.client._omniclient.Subscription

        

        

        Register file status callback.

        

        Args:

            callback (Callable[ServerUrl, OmniClientFileStatus, percent]): Callback to be called with the status.

        

        Returns:

            (omni.client.Subscription): Subscription Object. Callback will be unregistered once subcription is released.

    

    send_message_async(join_request_id: int, buffer) -> Tuple[omni.client._omniclient.Result]

        Asynchronously send message to channel. **(Coroutine version.)**

        

        Args:

            join_request_id (int): Join request id you get from omni.client.join_channel_with_callback.

            content (buffer): Content

        

        Returns:

            (omni.client.Result): Result object.

    

    send_message_with_callback(...) method of builtins.PyCapsule instance

        send_message_with_callback(join_request_id: int, content: buffer, callback: Callable[[omni.client._omniclient.Result], None]) -> omni.client._omniclient.Request

        

        

        

        Asynchronously send a message to a channel. **(Callback version.)**

        

        Args:

            join_request_id (int): Request id that you get from omni.client.join_channel_with_callback.

            content (buffer): Content

            callback (Callable[omni.client.Result]): Callback to be called with the result.

        

        Returns:

            (omni.client.Request): Request object.

    

    set_acls(url: str, acls: List[omni.client._omniclient.AclEntry]) -> Tuple[omni.client._omniclient.Result]

        Set the ACL's on a folder/file. **(Blocking version.)**

        

        Args:

            url (str): Url.

            acls (List[AclEntry]): The complete new set of ACLs to put on this file/folder.

            callback (Callable[omni.client.Result, List[AclEntry]): Callback to be called with the result and current ACLs.

        

        Returns:

            (omni.client.Request): Request object.

    

    set_acls_async(url: str, acls: List[omni.client._omniclient.AclEntry]) -> Tuple[omni.client._omniclient.Result]

        Set the ACL's on a folder/file. **(Coroutine version.)**

        

        Args:

            url (str): Url.

            acls (List[AclEntry]): The complete new set of ACLs to put on this file/folder.

            callback (Callable[omni.client.Result, List[AclEntry]): Callback to be called with the result and current ACLs.

        

        Returns:

            (omni.client.Request): Request object.

    

    set_acls_with_callback(...) method of builtins.PyCapsule instance

        set_acls_with_callback(url: str, acls: list, callback: Callable[[omni.client._omniclient.Result], None]) -> omni.client._omniclient.Request

        

        

        Asynchronously set the ACL's on a folder/file. **(Callback version.)**

        

        Args:

            url (str): Url.

            acls (List[AclEntry]): the complete new set of ACLs to put on this file/folder.

            callback (Callable[omni.client.Result, List[AclEntry]): Callback to be called with the result and current ACLs.

        

        Returns:

            (omni.client.Request): Request object.

    

    set_log_callback(...) method of builtins.PyCapsule instance

        set_log_callback(arg0: Callable[[str, str, omni.client._omniclient.LogLevel, str], None]) -> None

    

    set_log_level(...) method of builtins.PyCapsule instance

        set_log_level(arg0: omni.client._omniclient.LogLevel) -> None

    

    shutdown(...) method of builtins.PyCapsule instance

        shutdown() -> None

    

    sign_out(...) method of builtins.PyCapsule instance

        sign_out(arg0: str) -> None

        

        

        Sign out specific url connection.

        

        Args:

            url (str): Immediately disconnect from the server specified by this URL.

                       Any outstanding requests will call their callbacks with OmniClientResult.ErrorConnection.

                       Additionally, clear the saved authentication token so future requests to this server will

                       trigger re-authentication.

    

    stat(url: str) -> Tuple[omni.client._omniclient.Result, omni.client._omniclient.ListEntry]

        Synchronously retrieve information about a file or folder. **(Blocking version.)**

        

        Args:

            url (str): Url.

        Returns:

            (Tuple[Result, omni.client.ListEntry]]): Result and entry.

    

    stat_async(url: str) -> Tuple[omni.client._omniclient.Result, omni.client._omniclient.ListEntry]

        Asynchronously retrieve information about a file or folder. **(Coroutine version.)**

        

        Args:

            url (str): Url.

        Returns:

            (Tuple[Result, omni.client.ListEntry]]): Result and entry.

    

    stat_subscribe_with_callback(...) method of builtins.PyCapsule instance

        stat_subscribe_with_callback(url: str, stat_callback: Callable[[omni.client._omniclient.Result, omni.client._omniclient.ListEntry], None], subscribe_callback: Callable[[omni.client._omniclient.Result, omni.client._omniclient.ListEvent, omni.client._omniclient.ListEntry], None]) -> omni.client._omniclient.Subscription

        

        

        Subscribe to change notifications for a url. **(Callback version.)**

        If 'url' is a file, you will only receive information about that file.

        If 'url' is a folder, you will only receive information about that folder.

        '`stat_callback` is called once with the initial stat info,then '`subscribe_callback`' may be called multiple times after that the item changes.

        

        Args:

            url (str): Url.

            stat_callback(Callable[Result, omni.client.ListEntry]): Callback to be called once with the initial stat.

            subscribe_callback(Callable[Result, omni.client.ListEvent, omni.client.ListEntry]): Callback to be called when changes happen.

        

        Returns:

            Subscrption holder (`Subscription`).

    

    stat_with_callback(...) method of builtins.PyCapsule instance

        stat_with_callback(url: str, callback: Callable[[omni.client._omniclient.Result, omni.client._omniclient.ListEntry], None]) -> omni.client._omniclient.Request

        

        

        Asynchronously retrieve information about a file or folder. **(Callback version.)**

        

        Args:

            url (str): Url.

            callback(Callable[Result, omni.client.ListEntry]): Callback to be called with the results.

        

        Returns:

            (omni.client.Request): Request object.

    

    unlock_with_callback(...) method of builtins.PyCapsule instance

        unlock_with_callback(arg0: str, arg1: Callable[[omni.client._omniclient.Result], None]) -> omni.client._omniclient.Request

        

        

        

        Unlock a URL so other clients can modify it. **(Callback version.)**

        

        Args:

            url (str): URL.

    

    usd_live_get_default_enabled(...) method of builtins.PyCapsule instance

        usd_live_get_default_enabled() -> bool

        

        Get default live update mode.

    

    usd_live_get_latest_server_time(...) method of builtins.PyCapsule instance

        usd_live_get_latest_server_time(url: str) -> int

        

        

        Returns the server timestamp of the most recently received message (0 if no messages have been received).

    

    usd_live_get_mode_for_url(...) method of builtins.PyCapsule instance

        usd_live_get_mode_for_url(arg0: str) -> omni.client._omniclient.UsdLiveMode

        

        

        

        Get live update mode for specific URL.

        

        Args:

            url (str): Layer URL.

            

        Returns:

            (omni.client.OmniUsdLiveMode): Live update mode.

    

    usd_live_process(...) method of builtins.PyCapsule instance

        usd_live_process() -> None

        

        

        Call this to process live updates received from the server.

    

    usd_live_process_up_to(...) method of builtins.PyCapsule instance

        usd_live_process_up_to(url: str, server_time: int) -> None

        

        

        Same as omni.client.usd_live_process(false) but you can specify a server time to stop processing updates.

        

        Args:

            url (str): URL to process.

            server_time (int): The server time to stop processing updates.

    

    usd_live_set_default_enabled(...) method of builtins.PyCapsule instance

        usd_live_set_default_enabled(enabled: bool) -> None

        

        

        

        Live mode means updates from other users are applied to your scene.

        

            This API will change the live update mode for all layers if you don't set

            it for each layer.

        

        Args:

            enabled (bool): Enable live update mode globally or not.

    

    usd_live_set_mode_for_url(...) method of builtins.PyCapsule instance

        usd_live_set_mode_for_url(url: str, mode: omni.client._omniclient.UsdLiveMode) -> None

        

        

        

        Set live update mode for each layer.

        

        Args:

            url (str): Layer URL.

            mode (omni.client.OmniUsdLiveMode): Set live update mode per layer.

    

    usd_live_wait_for_pending_updates(...) method of builtins.PyCapsule instance

        usd_live_wait_for_pending_updates() -> None

        

        

        Call this to wait for all pending live updates to complete.

    

    write_file(url: str, buffer) -> Tuple[omni.client._omniclient.Result]

        Create a new file, overwriting if it already exists. **(Blocking version.)**

        

        Args:

            url (str): Url.

            content (buffer): Content

        

        Returns:

            (omni.client.Result): Result object.

    

    write_file_async(url: str, buffer) -> Tuple[omni.client._omniclient.Result]

        Asynchronously create a new file, overwriting if it already exists. **(Coroutine version.)**

        

        Args:

            url (str): Url.

            content (buffer): Content

        

        Returns:

            (omni.client.Result): Result object.

    

    write_file_with_callback(...) method of builtins.PyCapsule instance

        write_file_with_callback(url: str, content: buffer, callback: Callable[[omni.client._omniclient.Result], None]) -> omni.client._omniclient.Request

        

        

        

        Asynchronously create a new file, overwriting if it already exists. **(Callback version.)**

        

        Args:

            url (str): Url.

            content (buffer): Content

            callback (Callable[omni.client.Result]): Callback to be called with the result.

        

        Returns:

            (omni.client.Request): Request object.



DATA

    Callable = typing.Callable

    List = typing.List

    Tuple = typing.Tuple

    VERSION = 281530811285523



FILE

    samples\_build\target-deps\omni_client_library\release\bindings-python\omni\client\__init__.py