Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kefir500/vk-api-angular
VK Open API and widgets AngularJS wrapper.
https://github.com/kefir500/vk-api-angular
angularjs api api-wrapper promise vk vk-api
Last synced: about 1 month ago
JSON representation
VK Open API and widgets AngularJS wrapper.
- Host: GitHub
- URL: https://github.com/kefir500/vk-api-angular
- Owner: kefir500
- License: mit
- Created: 2017-02-08T09:17:43.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-06-22T07:30:33.000Z (over 3 years ago)
- Last Synced: 2024-04-27T10:08:20.475Z (7 months ago)
- Topics: angularjs, api, api-wrapper, promise, vk, vk-api
- Language: JavaScript
- Homepage: https://qwertycube.com/vk-api-angular/
- Size: 576 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# VK API Angular
[![Build Status](https://travis-ci.org/kefir500/vk-api-angular.svg)](https://travis-ci.org/kefir500/vk-api-angular)
[![Codecov](https://codecov.io/gh/kefir500/vk-api-angular/coverage.svg)](https://codecov.io/gh/kefir500/vk-api-angular)
[![devDependencies Status](https://david-dm.org/kefir500/vk-api-angular/dev-status.svg)](https://david-dm.org/kefir500/vk-api-angular?type=dev)VK Open API wrapper for AngularJS.
- Supports [VK API methods](https://vk.com/dev/methods) via AngularJS service.
- Supports [VK widgets](https://vk.com/dev/sites) via AngularJS directives.
- Replaces callbacks with promises.[Docs & Demo](https://kefir500.github.io/vk-api-angular/)
## VK API (service)
You may **initialize** your VK application using the provider during the configuration phase:
```javascript
angular.module('my-app', ['vk-api-angular'])
.config(function (VKApiProvider) {
VKApiProvider.init(10000); // Your VK APP_ID
});
```VKApi factory duplicates the official VK Open API method naming, in particular:
- `VKApi.Api.call`
- `VKApi.Auth.login`
- `VKApi.Auth.logout`
- `VKApi.Auth.revokeGrants`
- `VKApi.Auth.getLoginStatus`
- `VKApi.Auth.getSession`However, the promises are used instead of callbacks. This gives a better control over the success/error handling mechanism.
- [Methods List](https://vk.com/dev/methods)
- [Permissions List](https://vk.com/dev/permissions)```javascript
// Log in and request the "photos" and "video" permissions.
// See https://vk.com/dev/permissions for the full permission list.VKApi.Auth.login({
photos: true,
video: true
}).then(
// Success:
function (response) {
var name = response.session.user.first_name;
alert('Hello, ' + name + '!');
},
// Error:
function (response) {
alert('Sorry, access denied.');
console.error(response);
}
);
``````javascript
// Call "users.get" API method.
// See https://vk.com/dev/methods for the full method list.VKApi.Api.call('users.get').then(
// Success:
function (response) {
var name = response[0].first_name;
alert('Hello, ' + name + '!');
},
// Error:
function (response) {
alert('Sorry, could not fetch the user data.');
console.error(response);
}
);
```## VK Widgets (directives)
#### VK *Allow Messages From Community* Widget
```xml
```
#### VK *Auth* Widget
```xml
```
#### VK *Comments* Widget
```xml
```
#### VK *Community* Widget
```xml
```
#### VK *Community Messages* Widget
```xml
```
#### VK *Contact Us* Widget
```xml
```
#### VK *Like* Widget
```xml
```
#### VK *Poll* Widget
```xml
```
#### VK *Post* Widget
```xml
```
#### VK *Recommended* Widget
```xml
```
#### VK *Share* Widget
```xml
```
#### VK *Subscribe* Widget
```xml
```