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

openapi.api.DefaultApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to https://localhost:8080

Method	HTTP request	Description
getAvatar	GET /avatar/{userId}/{size}
getCapabilities	GET /ocs/v1.php/cloud/capabilities
getLoginFlowResult	POST /login/v2/poll
getNavigationApps	GET /ocs/v1.php/core/navigation/apps
getPreview	GET /core/preview.png
getStatus	GET /status.php
initLoginFlow	POST /login/v2

getAvatar

String getAvatar(userId, size)

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 | 
final size = 56; // int | 

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

Parameters

Name	Type	Description	Notes
userId	String
size	int

Return type

String

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]

getCapabilities

CoreServerCapabilities getCapabilities()

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.getCapabilities();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCapabilities: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

CoreServerCapabilities

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]

getLoginFlowResult

CoreLoginFlowResult getLoginFlowResult(coreLoginFlowQuery)

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 coreLoginFlowQuery = CoreLoginFlowQuery(); // CoreLoginFlowQuery | 

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

Parameters

Name	Type	Description	Notes
coreLoginFlowQuery	CoreLoginFlowQuery

Return type

CoreLoginFlowResult

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]

getNavigationApps

CoreNavigationApps getNavigationApps()

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.getNavigationApps();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getNavigationApps: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

CoreNavigationApps

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]

getPreview

String getPreview(file, x, y, mode, forceIcon, a)

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 file = file_example; // String | 
final x = 56; // int | 
final y = 56; // int | 
final mode = mode_example; // String | 
final forceIcon = true; // bool | 
final a = true; // bool | 

try {
    final result = api_instance.getPreview(file, x, y, mode, forceIcon, a);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPreview: $e\n');
}

Parameters

Name	Type	Description	Notes
file	String		[optional]
x	int		[optional]
y	int		[optional]
mode	String		[optional]
forceIcon	bool		[optional]
a	bool		[optional]

Return type

String

Authorization

basic_auth

HTTP request headers

• Content-Type: Not defined
• Accept: image/png

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

getStatus

CoreServerStatus 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

CoreServerStatus

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]

initLoginFlow

CoreLoginFlowInit initLoginFlow()

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.initLoginFlow();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->initLoginFlow: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

CoreLoginFlowInit

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]