nextcloud-neon/packages/nextcloud/doc/user_status/DefaultApi.md

openapi.api.DefaultApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to https://localhost:8080/ocs/v1.php/apps/user_status

Method	HTTP request	Description
clearMessage	DELETE /api/v1/user_status/message
findAllPredefinedStatuses	GET /api/v1/predefined_statuses
findAllStatuses	GET /api/v1/statuses
findStatus	GET /api/v1/statuses/{userId}
getStatus	GET /api/v1/user_status
heartbeat	PUT /api/v1/heartbeat
setCustomMessage	PUT /api/v1/user_status/message/custom
setPredefinedMessage	PUT /api/v1/user_status/message/predefined
setStatus	PUT /api/v1/user_status/status

clearMessage

clearMessage()

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: basic_auth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD';

final api_instance = DefaultApi();

try {
    api_instance.clearMessage();
} catch (e) {
    print('Exception when calling DefaultApi->clearMessage: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basic_auth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

findAllPredefinedStatuses

UserStatusPredefinedStatuses findAllPredefinedStatuses()

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: basic_auth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD';

final api_instance = DefaultApi();

try {
    final result = api_instance.findAllPredefinedStatuses();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->findAllPredefinedStatuses: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

UserStatusPredefinedStatuses

Authorization

basic_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

findAllStatuses

UserStatusFindAllStatuses findAllStatuses()

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: basic_auth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD';

final api_instance = DefaultApi();

try {
    final result = api_instance.findAllStatuses();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->findAllStatuses: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

UserStatusFindAllStatuses

Authorization

basic_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

findStatus

UserStatusFindStatus findStatus(userId)

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: basic_auth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD';

final api_instance = DefaultApi();
final userId = userId_example; // String | 

try {
    final result = api_instance.findStatus(userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->findStatus: $e\n');
}

Parameters

Name	Type	Description	Notes
userId	String

Return type

UserStatusFindStatus

Authorization

basic_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getStatus

UserStatusGetUserStatus getStatus()

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: basic_auth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD';

final api_instance = DefaultApi();

try {
    final result = api_instance.getStatus();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getStatus: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

UserStatusGetUserStatus

Authorization

basic_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

heartbeat

heartbeat(userStatusHeartbeat)

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: basic_auth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD';

final api_instance = DefaultApi();
final userStatusHeartbeat = UserStatusHeartbeat(); // UserStatusHeartbeat | 

try {
    api_instance.heartbeat(userStatusHeartbeat);
} catch (e) {
    print('Exception when calling DefaultApi->heartbeat: $e\n');
}

Parameters

Name	Type	Description	Notes
userStatusHeartbeat	UserStatusHeartbeat

Return type

void (empty response body)

Authorization

basic_auth

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setCustomMessage

UserStatusGetUserStatus setCustomMessage(userStatusSetCustomMessage)

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: basic_auth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD';

final api_instance = DefaultApi();
final userStatusSetCustomMessage = UserStatusSetCustomMessage(); // UserStatusSetCustomMessage | 

try {
    final result = api_instance.setCustomMessage(userStatusSetCustomMessage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setCustomMessage: $e\n');
}

Parameters

Name	Type	Description	Notes
userStatusSetCustomMessage	UserStatusSetCustomMessage

Return type

UserStatusGetUserStatus

Authorization

basic_auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setPredefinedMessage

UserStatusGetUserStatus setPredefinedMessage(userStatusSetPredefinedMessage)

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: basic_auth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD';

final api_instance = DefaultApi();
final userStatusSetPredefinedMessage = UserStatusSetPredefinedMessage(); // UserStatusSetPredefinedMessage | 

try {
    final result = api_instance.setPredefinedMessage(userStatusSetPredefinedMessage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setPredefinedMessage: $e\n');
}

Parameters

Name	Type	Description	Notes
userStatusSetPredefinedMessage	UserStatusSetPredefinedMessage

Return type

UserStatusGetUserStatus

Authorization

basic_auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setStatus

UserStatusGetUserStatus setStatus(userStatusSetUserStatus)

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: basic_auth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD';

final api_instance = DefaultApi();
final userStatusSetUserStatus = UserStatusSetUserStatus(); // UserStatusSetUserStatus | 

try {
    final result = api_instance.setStatus(userStatusSetUserStatus);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setStatus: $e\n');
}

Parameters

Name	Type	Description	Notes
userStatusSetUserStatus	UserStatusSetUserStatus

Return type

UserStatusGetUserStatus

Authorization

basic_auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]