educhat_api_alpha
EduchatApi - JavaScript client for educhat_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version: 31.23.0
- Package version: 31.23.0
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
Installation
Node.js
Fornpm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install educhat_api_alpha --save
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/educhat_api then install it via:
npm install YOUR_USERNAME/educhat_api_alpha --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Getting Started
Please follow the installation instruction and execute the following JS code:
var EduchatApi = require('educhat_api_alpha');
var defaultClient = EduchatApi.ApiClient.instance;
// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Token.apiKeyPrefix['Authorization'] = "Token"
var api = new EduchatApi.ApiApi()
var opts = {
'loginInput': new EduchatApi.LoginInput() // {LoginInput}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.apiLoginCreate(opts, callback);
Documentation for API Endpoints
All URIs are relative to https://api.edu.chat
Class | Method | HTTP request | Description |
---|---|---|---|
EduchatApi.ApiApi | apiLoginCreate | POST /v1/api/login/ | |
EduchatApi.ApiApi | apiLogoutCreate | POST /v1/api/logout/ | |
EduchatApi.ChatApi | chatAllList | GET /v1/chat/all/ | |
EduchatApi.ChatApi | chatCreate | POST /v1/chat/ | |
EduchatApi.ChatApi | chatDelete | DELETE /v1/chat/{id}/ | |
EduchatApi.ChatApi | chatJoinlistList | GET /v1/chat/joinlist/ | |
EduchatApi.ChatApi | chatList | GET /v1/chat/ | |
EduchatApi.ChatApi | chatPartialUpdate | PATCH /v1/chat/{id}/ | |
EduchatApi.Chat_userApi | chatUserCreate | POST /v1/chat_user/ | |
EduchatApi.Chat_userApi | chatUserDelete | DELETE /v1/chat_user/{chat}/{user}/ | |
EduchatApi.Chat_userApi | chatUserList | GET /v1/chat_user/ | |
EduchatApi.Chat_userApi | chatUserPartialUpdate | PATCH /v1/chat_user/{chat}/{user}/ | |
EduchatApi.Chat_userApi | chatUserPrivilegedList | GET /v1/chat_user/privileged/ | |
EduchatApi.Chat_userApi | chatUserTypingCreate | POST /v1/chat_user/typing/ | |
EduchatApi.FileApi | fileCreate | POST /v1/file/ | |
EduchatApi.FileApi | filePartialUpdate | PATCH /v1/file/{id}/ | |
EduchatApi.InstitutionApi | institutionDepartmentList | GET /v1/institution/department/ | |
EduchatApi.InstitutionApi | institutionSchoolList | GET /v1/institution/school/ | |
EduchatApi.InstitutionApi | institutionUniversityList | GET /v1/institution/university/ | |
EduchatApi.MessageApi | messageCreate | POST /v1/message/ | |
EduchatApi.MessageApi | messageList | GET /v1/message/ | |
EduchatApi.MessageApi | messagePartialUpdate | PATCH /v1/message/{id}/ | |
EduchatApi.MessageApi | messageReportCreate | POST /v1/message/report/ | |
EduchatApi.MessageApi | messageUpvoteCreate | POST /v1/message/upvote/ | |
EduchatApi.MessageApi | messageUpvoteList | GET /v1/message/upvote/ | |
EduchatApi.PasswordApi | passwordRequestCreate | POST /v1/password/request/ | |
EduchatApi.PasswordApi | passwordResetCreate | POST /v1/password/reset/ | |
EduchatApi.TagApi | tagChatCreate | POST /v1/tag/chat/ | |
EduchatApi.TagApi | tagChatDelete | DELETE /v1/tag/{tag}/chat/{chat}/ | |
EduchatApi.TagApi | tagList | GET /v1/tag/ | |
EduchatApi.TagApi | tagUserCreate | POST /v1/tag/user/ | |
EduchatApi.TagApi | tagUserDelete | DELETE /v1/tag/{tag}/user/{user}/ | |
EduchatApi.UserApi | userList | GET /v1/user/ | |
EduchatApi.UserApi | userMeList | GET /v1/user/me/ | |
EduchatApi.UserApi | userPartialUpdate | PATCH /v1/user/{id}/ | |
EduchatApi.UserApi | userPreferencesList | GET /v1/user/preferences/ | |
EduchatApi.UserApi | userPreferencesPartialUpdate | PATCH /v1/user/preferences/{id} | |
EduchatApi.UserApi | userSignupCreate | POST /v1/user/signup/ | |
EduchatApi.UserApi | userVerifyList | GET /v1/user/verify/ |
Documentation for Models
- EduchatApi.APIViewChatSerializer
- EduchatApi.APIViewUserSerializer
- EduchatApi.ChatAllIDSerializer
- EduchatApi.ChatAllListView
- EduchatApi.ChatJoinListView
- EduchatApi.ChatListCreateView
- EduchatApi.ChatListCreateView1
- EduchatApi.ChatListSerializer
- EduchatApi.ChatSerializer
- EduchatApi.ChatTagSerializer
- EduchatApi.ChatTagView
- EduchatApi.ChatUpdateDestroyView
- EduchatApi.ChatUserIsTypingView
- EduchatApi.ChatUserListCreateView
- EduchatApi.ChatUserPostSerializer
- EduchatApi.ChatUserPrivilegedListView
- EduchatApi.ChatUserPrivilegedSerializer
- EduchatApi.ChatUserPromotionSerializer
- EduchatApi.ChatUserSerializer
- EduchatApi.ChatUserTypingSerializer
- EduchatApi.ColorSerializer
- EduchatApi.DepartmentSerializer
- EduchatApi.DepartmentView
- EduchatApi.FileCreateView
- EduchatApi.FileSerializer
- EduchatApi.Login
- EduchatApi.LoginInput
- EduchatApi.LoginOutput
- EduchatApi.LogoutView
- EduchatApi.MessageListCreateView
- EduchatApi.MessageListCreateView1
- EduchatApi.MessageReportSerializer
- EduchatApi.MessageReportSerializer1
- EduchatApi.MessageReportView
- EduchatApi.MessageSendSerializer
- EduchatApi.MessageSerializer
- EduchatApi.MessageUpVoteListCreateView
- EduchatApi.MessageUpVoteListCreateView1
- EduchatApi.MessageUpdateSerializer
- EduchatApi.MessageUpdateView
- EduchatApi.MessageUserSerializer
- EduchatApi.PasswordReset
- EduchatApi.RequestPassword
- EduchatApi.SchoolSerializer
- EduchatApi.SchoolView
- EduchatApi.TagSerializer
- EduchatApi.TagView
- EduchatApi.UniversitySerializer
- EduchatApi.UniversityView
- EduchatApi.UpvoteMessageUserSerializer
- EduchatApi.UserListView
- EduchatApi.UserPreferenceSerializer
- EduchatApi.UserPreferencesRetreiveView
- EduchatApi.UserSerializer
- EduchatApi.UserTagSerializer
- EduchatApi.UserTagView
- EduchatApi.UserTokenRetrieveView
- EduchatApi.UserUpdateSerializer
Documentation for Authorization
Token
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header