Skip to content

Latest commit

 

History

History
151 lines (111 loc) · 3.18 KB

README.md

File metadata and controls

151 lines (111 loc) · 3.18 KB

VK API Angular

Build Status Codecov devDependencies Status

VK Open API wrapper for AngularJS.

  • Supports VK API methods via AngularJS service.
  • Supports VK widgets via AngularJS directives.
  • Replaces callbacks with promises.

Docs & Demo

VK API (service)

You may initialize your VK application using the provider during the configuration phase:

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.

// 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);
  }
);
// 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

<vk-allow-messages-from-community group-id="ID"></vk-allow-messages-from-community>

VK Auth Widget

<vk-auth></vk-auth>

VK Comments Widget

<vk-comments></vk-comments>

VK Community Widget

<vk-community group-id="ID"></vk-community>

VK Community Messages Widget

<vk-community-messages group-id="ID"></vk-community-messages>

VK Contact Us Widget

<vk-contact-us owner-id="ID"></vk-contact-us>

VK Like Widget

<vk-like></vk-like>

VK Poll Widget

<vk-poll poll-id="POLL"></vk-poll>

VK Post Widget

<vk-post owner-id="ID" post-id="POST" hash="HASH"></vk-post>

VK Recommended Widget

<vk-recommended></vk-recommended>

VK Share Widget

<vk-share></vk-share>

VK Subscribe Widget

<vk-subscribe owner-id="ID"></vk-subscribe>