aurora
/
nextcloud-neon
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
A framework for building convergent cross-platform Nextcloud clients using Flutter.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
121 Commits
24 Branches
0 Tags
53 MiB
 
 
Tree: 3a24999530
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '3a24999530'
${ noResults }
nextcloud-neon/packages/nextcloud/doc/user_status/DefaultApi.md

11 KiB
Raw Blame History

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(status)

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 status = ; // UserStatusTypeEnum | 

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

Parameters

Name Type Description Notes
status UserStatusTypeEnum

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]

setCustomMessage

UserStatusGetUserStatus setCustomMessage(statusIcon, message, clearAt)

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 statusIcon = statusIcon_example; // String | 
final message = message_example; // String | 
final clearAt = 56; // int | 

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

Parameters

Name Type Description Notes
statusIcon String [optional]
message String [optional]
clearAt int [optional]

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]

setPredefinedMessage

UserStatusGetUserStatus setPredefinedMessage(messageId, clearAt)

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 messageId = messageId_example; // String | 
final clearAt = 56; // int | 

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

Parameters

Name Type Description Notes
messageId String
clearAt int [optional]

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]

setStatus

UserStatusGetUserStatus setStatus(statusType)

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 statusType = ; // UserStatusTypeEnum | 

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

Parameters

Name Type Description Notes
statusType UserStatusTypeEnum

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]