@types/ng-facebook
TypeScript icon, indicating that this package has built-in type declarations

0.0.26 • Public • Published

Installation

npm install --save @types/ng-facebook

Summary

This package contains type definitions for ng-facebook (https://github.com/GoDisco/ngFacebook).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ng-facebook.

index.d.ts

/// <reference types="angular" />
/// <reference types="facebook-js-sdk" />

import * as angular from "angular";

declare module "angular" {
    export namespace ngFacebook {
        interface IFacebookProvider {
            setAppId(appId: string): IFacebookProvider;
            getAppId(): string;

            setVersion(version: string): IFacebookProvider;
            getVersion(): string;

            setPermissions(permissions: string | string[]): IFacebookProvider;
            getPermissions(): string;

            setCustomInit(customInit: Partial<facebook.InitParams>): IFacebookProvider;
            getCustomInit(): facebook.InitParams;
        }

        type FBUIParams =
            | facebook.ShareDialogParams
            | facebook.ShareOpenGraphDialogParams
            | facebook.AddPageTabDialogParams
            | facebook.GameRequestDialogParams
            | facebook.SendDialogParams
            | facebook.PayDialogParams
            | facebook.PaymentsLiteDialogParams
            | facebook.LiveDialogParams
            | facebook.CreateOfferDialogParams
            | facebook.LeadgenDialogParams
            | facebook.InstantExperiencesAdsDialogParams
            | facebook.InstantExperiencesPreviewDialogParams
            | facebook.CollectionAdsDialogParams;

        interface IFacebookService {
            config<T extends string | number | facebook.InitParams>(property: string): T;
            init(): void;

            setCache<T>(attr: string, val: T): void;
            getCache<T>(attr: string): T;
            clearCache(): void;

            isConnected(): boolean;
            getAuthResponse(): {};
            getLoginStatus(force?: boolean): angular.IPromise<{}>;
            login(permissions?: string, rerequest?: boolean): angular.IPromise<{}>;
            logout(): angular.IPromise<void>;

            ui(params: FBUIParams): angular.IPromise<any>;
            api(path: string): angular.IPromise<{}>;
            api(path: string, method: string): angular.IPromise<{}>;
            api(path: string, params: Object): angular.IPromise<{}>;
            api(path: string, method: string, params: Object): angular.IPromise<{}>;

            cachedApi(path: string): angular.IPromise<any>;
        }
    }
}

Additional Details

Credits

These definitions were written by Crevil.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/ng-facebook

Weekly Downloads

2

Version

0.0.26

License

MIT

Unpacked Size

7.27 kB

Total Files

5

Last publish

Collaborators

  • types