Package com.smartsheet.api

Interface Smartsheet

  • public interface Smartsheet

    This interface is the entry point of the Smartsheet SDK, it provides convenient methods to get XXXResources instances for accessing different types of resources.

    Thread Safety: Implementation of this interface must be thread safe.

    • Method Detail

      • setTraces

        void setTraces​(Trace... levels)

        Enable request/response tracing in client

        Parameters:
        levels - - what to trace (if anything; null if not tracing at all)

      • setTracePrettyPrint

        void setTracePrettyPrint​(boolean pretty)
        enable/disable pretty JSON trace logging
        Parameters:
        pretty - if the JSON is nicely-formatted or compact

      • setAccessToken

        void setAccessToken​(java.lang.String accessToken)

        Set the access token to use.

        Parameters:
        accessToken - the new access token
        Throws:
        java.lang.IllegalArgumentException - if any argument is null/empty string

      • setAssumedUser

        void setAssumedUser​(java.lang.String assumedUser)

        Set the email of the user to assume.

        Parameters:
        assumedUser - the new assumed user
        Throws:
        java.lang.IllegalArgumentException - if any argument is null/empty string

      • setChangeAgent

        void setChangeAgent​(java.lang.String changeAgent)

        Set the change agent identifier.

        Parameters:
        changeAgent - the new change agent
        Throws:
        java.lang.IllegalArgumentException - if any argument is null/empty string

      • setUserAgent

        void setUserAgent​(java.lang.String userAgent)

        Set the user agent header string.

        Parameters:
        userAgent - the new user agent string
        Throws:
        java.lang.IllegalArgumentException - if any argument is null/empty string

      • setMaxRetryTimeMillis

        void setMaxRetryTimeMillis​(long maxRetryTimeMillis)

        Sets the max retry time if the HttpClient is an instance of DefaultHttpClient

        Parameters:
        maxRetryTimeMillis - max retry time

      • homeResources

        @Deprecated(since="3.4.0",
            forRemoval=true)
HomeResources homeResources()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Home resources have been deprecated and will be removed in a future version.

        Returns the HomeResources instance that provides access to Home resources.

        Returns:
        the home resources instance

      • workspaceResources

        WorkspaceResources workspaceResources()

        Returns the WorkspaceResources instance that provides access to Workspace resources.

        Returns:
        the workspace resources instance

      • folderResources

        FolderResources folderResources()

        Returns the FolderResources instance that provides access to Folder resources.

        Returns:
        the folder resources instance

      • templateResources

        TemplateResources templateResources()

        Returns the TemplateResources instance that provides access to Template resources.

        Returns:
        the template resources instance

      • sheetResources

        SheetResources sheetResources()

        Returns the SheetResources instance that provides access to Sheet resources.

        Returns:
        the sheet resources instance

      • sightResources

        SightResources sightResources()

        Returns the SightResources instance that provides access to Sight resources.

        Returns:
        the sight resources instance

      • favoriteResources

        FavoriteResources favoriteResources()

        Returns the FavoriteResources instance that provides access to Favorite resources.

        Returns:
        the favorite resources instance

      • userResources

        UserResources userResources()

        Returns the UserResources instance that provides access to User resources.

        Returns:
        the user resources instance

      • groupResources

        GroupResources groupResources()

        Returns the GroupResources instance that provides access to Group resources.

        Returns:
        the group resources instance

      • serverInfoResources

        ServerInfoResources serverInfoResources()

        Returns the ServerInfoResources instance that provides access to Server Info resources.

        Returns:
        the serverinfo resources instance

      • searchResources

        SearchResources searchResources()

        Returns the SearchResources instance that provides access to searching resources.

        Returns:
        the search resources instance

      • reportResources

        ReportResources reportResources()

        Returns the ReportResources instance that provides access to report resources.

        Returns:
        the report resources instance

      • tokenResources

        TokenResources tokenResources()

        Returns the TokenResources instance that provides access to token resources.

        Returns:
        the token resources instance

      • contactResources

        ContactResources contactResources()

        Returns the ContactResources instance that provides access to contact resources.

        Returns:
        the contact resources instance

      • imageUrlResources

        ImageUrlResources imageUrlResources()
        Returns the ImageUrlResources instance that provides access to image Url resources
        Returns:
        the image Url resources instance

      • webhookResources

        WebhookResources webhookResources()
        Returns the WebhookResources instance that provides access to webhook resources
        Returns:
        the webhook resources instance

      • passthroughResources

        PassthroughResources passthroughResources()
        Returns the PassthroughResources instance that provides access to passthrough resources
        Returns:
        the passthrough resources instance

      • eventResources

        EventResources eventResources()
        Returns the EventResources instance that provides access to event resources
        Returns:
        the event resources instance

      • assetShareResources

        AssetShareResources assetShareResources()
        Returns the AssetShareResources instance that provides access to Asset Share resources
        Returns:
        the asset share resources instance