Session class

Available extensions

• Chatting
• Cube
• DataSource
• Mailbox
• Users

Constructors

Session()

Properties

dio → Dio

final

hashCode → int

The hash code for this object.

no setter, inherited

profile → Profile

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

availabilityMode(AvailabilityMode mode) → Future

chat(String contactId, {String? text, Map<String, dynamic>? resource}) → Future<Chat>

Available on Session, provided by the Chatting extension

checkIn(int id, int fileId, int version, File file) → Future<Attachment>

Available on Session, provided by the Mailbox extension

checkOut(int id, int fileId, int version) → Future

Available on Session, provided by the Mailbox extension

combinations(String cube, {Map<String, dynamic>? axes}) → Future<List<List<String>>>

Available on Session, provided by the Cube extension

comment(int documentId, {String? text, Map<String, dynamic>? resource}) → Future<Comment>

Available on Session, provided by the Mailbox extension

commentsTyping(int documentId) → Future

Available on Session, provided by the Mailbox extension

company() → Future<String?>

constraints(String cube, {Map<String, dynamic>? axes}) → Future<Map<String, Map<String, dynamic>>>

Available on Session, provided by the Cube extension

conversation(String contactId, {DateTime? before, int? take}) → Future<Iterable<Chat>>

Available on Session, provided by the Chatting extension

create(String formId, {double? longitude, double? latitude}) → Future<RecipientModel>

Available on Session, provided by the Mailbox extension

currencies() → Future<Iterable<CurrencyInfo>>

Available on Session, provided by the Cube extension

Get currencies list. See exchangeRate

dashboard(String name) → Future

deleteAttachment(int id, int fileId, int version) → Future

Available on Session, provided by the Mailbox extension

deleteComment(int documentId, int commentId) → Future

Available on Session, provided by the Mailbox extension

discard(int id) → dynamic

Available on Session, provided by the Mailbox extension

download(int documentId, int fileId, {dynamic progress(int, int)?}) → Future<String>

Available on Session, provided by the Mailbox extension

editComment(int documentId, int commentId, {String? text, Map<String, dynamic>? resource}) → Future<Comment>

Available on Session, provided by the Mailbox extension

exchangeRate(String code, {DateTime? date}) → Future<double>

Available on Session, provided by the Cube extension

Get currency exchange rate.

exists() → bool

explore(String cube, {Map<String, dynamic>? axes}) → Future<List<Map<String, dynamic>>>

Available on Session, provided by the Cube extension

exploreIndex(String cube, String index, {Map<String, dynamic>? axes}) → Future<List<Map<String, dynamic>>>

Available on Session, provided by the Cube extension

find(String id) → Future<UserInfo>

Available on Session, provided by the Users extension

Find a user by id

findAll(String name, {int? take}) → Future<List<UserInfo>>

Available on Session, provided by the Users extension

List users filtered by name

flag(int id, bool val) → Future

Available on Session, provided by the Mailbox extension

geoLocation() → Future<LocationData?>

get(int id) → Future<RecipientModel>

Available on Session, provided by the Mailbox extension

hasServerUri() → Future<bool>

map(String name) → Future<Map<String, String>>

Available on Session, provided by the DataSource extension

Retrieve datatype values by name

messages({String? folderId, String? contains, QueryType? queryType, int? skip, int take = 20}) → Future<Iterable<HeaderModel>>

Available on Session, provided by the Mailbox extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifications({DateTime? before}) → Future<Iterable<NotificationBase>>

online(bool val) → Future

patterns(String cube) → Future<Iterable<PatternInfo>>

Available on Session, provided by the Cube extension

refresh() → Future

resolve(String cube, {Map<String, dynamic>? axes}) → Future<ExploreType>

Available on Session, provided by the Cube extension

save(int id, int version, [Map? data]) → Future<RecipientModel>

Available on Session, provided by the Mailbox extension

seen(String contactId) → Future

Available on Session, provided by the Chatting extension

seenComments(int documentId) → Future<DateTime>

Available on Session, provided by the Mailbox extension

seenMessages() → Future

seenNotifications() → Future

segmentValues(String cube, String axis) → Future<Map<String, dynamic>>

Available on Session, provided by the Cube extension

send(int id, int version, String actionId, Map<String, dynamic>? args, [Map? data]) → Future<RecipientModel>

Available on Session, provided by the Mailbox extension

series(String cube, List<String> xAxis, {List<String>? series, List<String>? indices, Map<String, dynamic>? filters, bool? groupIndices, bool? inverseIndices}) → Future<List<CubeSeries>>

Available on Session, provided by the Cube extension

Retrieve series of cube by xAxis. If series are set, each CubeSeries.name receive the series group value. If indices are set, each CubeSeries.index is set to the index name.

setup(String serverUri) → dynamic

submit(int id, int version, [Map? data]) → Future<RecipientModel>

Available on Session, provided by the Mailbox extension

table(String cube, List<String> columns, {List<String>? indices, Map<String, dynamic>? filters}) → Future<List<Map>>

Available on Session, provided by the Cube extension

Flat iterable records of cube.

toString() → String

A string representation of this object.

inherited

tryRestore() → Future<bool>

typing(String contactId) → Future

Available on Session, provided by the Chatting extension

upload(int id, int version, Iterable<File> files) → Future<List<Attachment>>

Available on Session, provided by the Mailbox extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited