QuickBaseClient class

Constructors

QuickBaseClient({required String qBRealmHostname, required dynamic appToken})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

qBRealmHostname → String

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cloneUserToken({required UserTokenCloneRequest request, required String authorization, String? userAgent}) → Future<UserTokenResponse>

Clone a user token

copyApp({required String appId, required AppIdCopyRequest request, String? userAgent, String? authorization}) → Future<AppResponse>

Copy an app

createApp({required String appId, required AppUpsertRequest request, String? userAgent, String? authorization}) → Future<AppResponse>

Create an app

createField({required String? tableId, required FieldsUpsertRequest request, String? authorization, String? userAgent}) → Future<FieldResponse>

Create a field

createRelationship({required String tableId, required TableIdRelationshipRequest request, String? authorization, String? userAgent}) → Future<TableRelationshipResponse>

Create a relationship

createTable({required String appId, required TablesUpsertRequest request, String? authorization, String? userAgent}) → Future<TableResponse>

Create a table

deactivateUserToken({required String authorization, String? userAgent}) → Future<int>

Deactivate a user token

deleteApp({required String appId, required String appName, String? authorization, String? userAgent}) → Future<String>

Delete an app

deleteFields({required String tableId, required FieldsRequest request, String? authorization, String? userAgent}) → Future<FieldsDeletedResponse>

Delete field(s)

deleteFile({required String tableId, required int recordId, required int fieldId, required int versionNumber, String? authorization, String? userAgent}) → Future<String>

Delete file

deleteRecords({required RecordsDeleteRequest request, String? authorization, String? userAgent}) → Future<int>

Delete record(s)

deleteTable({required String tableId, required String appId, String? authorization, String? userAgent}) → Future<String>

Delete a table

deleteUserToken({required String authorization, String? userAgent}) → Future<Map<String, Object>>

Delete a user token

denyUsers({required List<String> userIds, String? authorization, String? userAgent}) → Future<DenyUsersResponse>

Deny users

denyUsersAndGroups({required bool shouldDeleteFromGroups, required List<String> userIds, String? authorization, String? userAgent}) → Future<DenyUsersResponse>

Deny and remove users from groups

downloadFile({required String tableId, required int recordId, required int fieldId, required int versionNumber, String? authorization, String? userAgent}) → Future<DeleteFileResponse>

Download file

getApp({required String appId, String? authorization, String? userAgent}) → Future<AppResponse>

Get an app

getAppEvents({required String appId, String? authorization, String? userAgent}) → Future<List<AppEvent>>

Get app events

getAppTables({required String appId, String? authorization, String? userAgent}) → Future<List<TableResponse>>

Get tables for an app

getField({required int fieldId, required String tableId, String? authorization, bool? includeFieldPerms, String? userAgent}) → Future<FieldResponse>

Get field

getFields({required String tableId, String? authorization, bool? includeFieldPerms, String? userAgent}) → Future<List<FieldResponse>>

Get fields for a table

getFieldsUsage({required String tableId, String? authorization, GetFieldUsagesRequest? request, String? userAgent}) → Future<List<FieldUsageResponse>>

Get usage for all fields

getFieldUsage({required int fieldId, required String tableId, String? authorization, String? userAgent}) → Future<FieldUsageResponse>

Get usage for a field

getRelationships({required String tableId, String? authorization, int? skip, String? userAgent}) → Future<RelationShipListResponse>

Get all relationships

getReport({required String reportId, required String tableId, String? authorization, String? userAgent}) → Future<ReportResponse>

Get a report

getTable({required String tableId, required String appId, String? authorization, String? userAgent}) → Future<TableResponse>

Get a table

getTableReports({required String tableId, String? authorization, String? userAgent}) → Future<List<ReportResponse>>

Get reports for a table

getTempTokenDBID({required String dbid, String? userAgent}) → Future<String>

initialize() → Future<void>

Initializes the client

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

runFormula({required FormulaRunRequest body, String? authorization, String? userAgent}) → Future<String>

Run a formula

runQuery({required RecordsQueryRequest request, String? authorization, String? userAgent}) → Future<RecordsQueryResponse>

Query for data

runReport({required RunReportRequest request, required String reportId, String? authorization, String? userAgent}) → Future<RunReportResponse>

Run a report

toString() → String

A string representation of this object.

inherited

updateApp({required String appId, String? authorization, required AppUpsertRequest request, String? userAgent}) → Future<AppResponse>

Update an app

updateField({required String tableId, required int fieldId, required FieldsUpsertRequest request, String? authorization, String? userAgent}) → Future<FieldResponse>

Update a field

updateRelationship({required String tableId, required int relationshipId, required TableIdRelationshipRequest request, String? authorization, String? userAgent}) → Future<TableRelationshipResponse>

Update a relationship

updateTable({required String appId, required String tableId, required TablesUpsertRequest request, String? authorization, String? userAgent}) → Future<TableResponse>

Update a table

upsert({required RecordsUpsertRequest request, String? authorization, String? userAgent}) → Future<RecordsUpsertResponse>

Insert/Update record(s)

Operators

operator ==(Object other) → bool

The equality operator.

inherited