Inbox Uploads

An InboxUpload is a log record about upload operations that happened in your Inbox.

List Inbox Uploads

SDK Method

inbox_upload.List()

Return Values

Returns a *inbox_upload.Iter and an error. Range over All() to receive files_sdk.InboxUpload values and errors. Check each loop error before using its resource. Next() and Err() remain supported.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a Folder Administrator for the relevant folder.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    inbox_upload "github.com/Files-com/files-sdk-go/v3/inboxupload"
)

inboxUploadIterator, err := inbox_upload.List(files_sdk.InboxUploadListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

for inboxUpload, err := range inboxUploadIterator.All() {
    if err != nil {
        var respErr files_sdk.ResponseError
        if errors.As(err, &respErr) {
            fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
        } else {
            fmt.Printf("Request failed: %v\n", err)
        }
        return
    }
    fmt.Println(inboxUpload)
}

The InboxUpload Object

Some of the methods above return a InboxUpload object. The attributes of this object are listed below.

AttributeDescription
InboxRegistration
InboxRegistration
Path
string
Upload path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
CreatedAt
date-time
Upload date/time