github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-01-19 16:52:53 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #207 from driftyco/new-contacts

Browse Source 
New contacts
This commit is contained in:
Ibrahim Hadeed 2016-06-10 19:38:17 -04:00 committed by GitHub
commit 4b121520dd
3 changed files with 125 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/index.ts
View File

@ -66,6 +66,7 @@ import {Vibration} from './plugins/vibration';
import {WebIntent} from './plugins/webintent';
export * from './plugins/googlemaps';
export * from './plugins/3dtouch';
export * from './plugins/contacts';
export {
ActionSheet,
AdMob,

233
src/plugins/contacts.ts
View File

@ -1,6 +1,7 @@
import {Plugin, Cordova} from './plugin';
export interface ContactProperties {
import {Plugin, Cordova, InstanceProperty, CordovaInstance} from './plugin';
declare var window: any,
navigator: any;
export interface IContactProperties {
/** A globally unique identifier. */
id?: string;
/** The name of this Contact, suitable for display to end users. */
@ -10,13 +11,13 @@ export interface ContactProperties {
/** A casual name by which to address the contact. */
nickname?: string;
/** An array of all the contact's phone numbers. */
phoneNumbers?: ContactField[];
phoneNumbers?: IContactField[];
/** An array of all the contact's email addresses. */
emails?: ContactField[];
emails?: IContactField[];
/** An array of all the contact's addresses. */
addresses?: ContactAddress[];
/** An array of all the contact's IM addresses. */
ims?: ContactField[];
ims?: IContactField[];
/** An array of all the contact's organizations. */
organizations?: ContactOrganization[];
/** The birthday of the contact. */
@ -24,45 +25,51 @@ export interface ContactProperties {
/** A note about the contact. */
note?: string;
/** An array of the contact's photos. */
photos?: ContactField[];
photos?: IContactField[];
/** An array of all the user-defined categories associated with the contact. */
categories?: ContactField[];
categories?: IContactField[];
/** An array of web pages associated with the contact. */
urls?: ContactField[];
urls?: IContactField[];
}
export interface Contact extends ContactProperties {
/**
* Returns a new Contact object that is a deep copy of the calling object, with the id property set to null
*/
clone(): Contact;
/**
* Removes the contact from the device contacts database, otherwise executes an error callback with a ContactError object.
* @param onSuccess Success callback function invoked on success operation.
* @param onError Error callback function, invoked when an error occurs.
*/
remove(
onSuccess?: () => void,
onError?: (error: Error) => void): void;
/**
* Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same id already exists.
* @param onSuccess Success callback function invoked on success operation with che Contact object.
* @param onError Error callback function, invoked when an error occurs.
*/
save(
onSuccess?: (contact: Contact) => void,
onError?: (error: Error) => void): void;
export class Contact {
private _objectInstance: any;
@InstanceProperty get id(): string {return; }
@InstanceProperty get displayName(): string {return; }
@InstanceProperty get nickname(): ContactName {return; }
@InstanceProperty get phoneNumbers(): string {return; }
@InstanceProperty get emails(): IContactField[] {return; }
@InstanceProperty get addresses(): ContactAddress[] {return; }
@InstanceProperty get ims(): IContactField[] {return; }
@InstanceProperty get organizations(): ContactOrganization[] {return; }
@InstanceProperty get birthday(): Date {return; }
@InstanceProperty get note(): string {return; }
@InstanceProperty get photos(): IContactField[] {return; }
@InstanceProperty get categories(): IContactField[] {return; }
@InstanceProperty get urls(): IContactField[] {return; }
constructor () {
this._objectInstance = navigator.contacts.create();
}
clone(): Contact {
let newContact = new Contact();
for (let prop in this) {
if (prop === 'id') return;
newContact[prop] = this[prop];
}
return newContact;
}
@CordovaInstance()
remove(): Promise<any> {return; }
@CordovaInstance()
save(): Promise<any> {return; }
}
interface ContactError {
interface IContactError {
/** Error code */
code: number;
/** Error message */
message: string;
}
declare var ContactError: {
new(code: number): ContactError;
new(code: number): IContactError;
UNKNOWN_ERROR: number;
INVALID_ARGUMENT_ERROR: number;
TIMEOUT_ERROR: number;
@ -71,8 +78,7 @@ declare var ContactError: {
NOT_SUPPORTED_ERROR: number;
PERMISSION_DENIED_ERROR: number
};
export interface ContactName {
export interface IContactName {
/** The complete name of the contact. */
formatted?: string;
/** The contact's family name. */
@ -86,18 +92,20 @@ export interface ContactName {
/** The contact's suffix (example Esq.). */
honorificSuffix?: string;
}
export class ContactName implements IContactName {
private _objectInstance: any;
constructor(formatted?: string, familyName?: string, givenName?: string, middleName?: string, honorificPrefix?: string, honorificSuffix?: string) {
this._objectInstance = new window.ContactName(formatted, familyName, givenName, middleName, honorificPrefix, honorificSuffix);
}
@InstanceProperty get formatted(): string {return; }
@InstanceProperty get familyName(): string {return; }
@InstanceProperty get givenName(): string {return; }
@InstanceProperty get middleName(): string {return; }
@InstanceProperty get honorificPrefix(): string {return; }
@InstanceProperty get honorificSuffix(): string {return; }
}
declare var ContactName: {
/** Constructor for ContactName object */
new(formatted?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string): ContactName
};
export interface ContactField {
export interface IContactField {
/** A string that indicates what type of field this is, home for example. */
type: string;
/** The value of the field, such as a phone number or email address. */
@ -106,14 +114,17 @@ export interface ContactField {
pref: boolean;
}
declare var ContactField: {
/** Constructor for ContactField object */
new(type?: string,
value?: string,
pref?: boolean): ContactField
};
export class ContactField implements IContactField {
private _objectInstance: any;
constructor(type?: string, value?: string, pref?: boolean) {
this._objectInstance = new window.ContactField(type, value, pref);
}
@InstanceProperty get type(): string {return; }
@InstanceProperty get value(): string {return; }
@InstanceProperty get pref(): boolean {return; }
}
export interface ContactAddress {
export interface IContactAddress {
/** Set to true if this ContactAddress contains the user's preferred value. */
pref?: boolean;
/** A string indicating what type of field this is, home for example. */
@ -132,19 +143,29 @@ export interface ContactAddress {
country?: string;
}
declare var ContactAddress: {
/** Constructor of ContactAddress object */
new(pref?: boolean,
type?: string,
formatted?: string,
streetAddress?: string,
locality?: string,
region?: string,
postalCode?: string,
country?: string): ContactAddress
};
export class ContactAddress implements IContactAddress {
private _objectInstance: any;
constructor (pref?: boolean,
type?: string,
formatted?: string,
streetAddress?: string,
locality?: string,
region?: string,
postalCode?: string,
country?: string) {
this._objectInstance = new window.ContactAddress(pref, type, formatted, streetAddress, locality, region, postalCode, country);
}
@InstanceProperty get pref(): boolean {return; }
@InstanceProperty get type(): string {return; }
@InstanceProperty get formatted(): string {return; }
@InstanceProperty get streetAddress(): string {return; }
@InstanceProperty get locality(): string {return; }
@InstanceProperty get region(): string {return; }
@InstanceProperty get postalCode(): string {return; }
@InstanceProperty get country(): string {return; }
}
export interface ContactOrganization {
export interface IContactOrganization {
/** Set to true if this ContactOrganization contains the user's preferred value. */
pref?: boolean;
/** A string that indicates what type of field this is, home for example. */
@ -157,17 +178,20 @@ export interface ContactOrganization {
title?: string;
}
declare var ContactOrganization: {
/** Constructor for ContactOrganization object */
new(pref?: boolean,
type?: string,
name?: string,
department?: string,
title?: string): ContactOrganization
};
export class ContactOrganization implements IContactOrganization {
private _objectInstance: any;
constructor () {
this._objectInstance = new window.ContactOrganization();
}
@InstanceProperty get pref(): boolean {return; }
@InstanceProperty get type(): string {return; }
@InstanceProperty get name(): string {return; }
@InstanceProperty get department(): string {return; }
@InstanceProperty get title(): string {return; }
}
/** Search options to filter navigator.contacts. */
interface ContactFindOptions {
export interface IContactFindOptions {
/** The search string used to find navigator.contacts. */
filter?: string;
/** Determines if the find operation returns multiple navigator.contacts. */
@ -176,35 +200,34 @@ interface ContactFindOptions {
desiredFields?: string[];
}
declare var ContactFindOptions: {
/** Constructor for ContactFindOptions object */
new(filter?: string,
multiple?: boolean,
desiredFields?: string[]): ContactFindOptions
};
declare var Contact: {
new(): Contact
};
export class ContactFindOptions implements IContactFindOptions {
private _objectInstance: any;
constructor () {
this._objectInstance = new window.ContactFindOptions();
}
@InstanceProperty get filter(): string {return; }
@InstanceProperty get multiple(): boolean {return; }
@InstanceProperty get desiredFields(): any {return; }
@InstanceProperty get hasPhoneNumber(): boolean {return; }
}
/**
* @name Contacts
* @description
* Access and manage Contacts on the device.
*
* Requires plugin: `cordova-plugin-contacts`
* For full info, please see the [Cordova Contacts plugin docs](https://github.com/apache/cordova-plugin-contacts)
*
* @usage
*
* ```js
* import {Contacts} from 'ionic-native';
* import {Contact} from 'ionic-native';
*
*
*
* Contacts.create({
* displayName: "Mr. Ionitron"
* }).then((contact) => {}, (err) => {})
* let contact = new Contact();
* contact.displayName = "Mr. Ionitron";
* contact.save().then(
* () => console.log("Contact saved!", contact),
* (error: any) => console.error("Error saving contact.", error)
* );
* ```
*
*
@ -215,19 +238,9 @@ declare var Contact: {
repo: 'https://github.com/apache/cordova-plugin-contacts'
})
export class Contacts {
/**
* Create a new Contact object.
*
* @param options {Object} Object whose properties the created Contact should have.
* @return {Contact} Returns the created contact
*/
@Cordova({
sync: true
})
static create(options: ContactProperties) {
return new Contact();
};
static create(): Contact {
return new Contact();
}
/**
* Search for contacts in the Contacts list.
*
@ -250,12 +263,10 @@ export class Contacts {
errorIndex: 2
})
static find(fields: string[], options?: any): Promise<any> { return; }
/**
* Select a single Contact.
* @return Returns a Promise that resolves with the selected Contact
*/
@Cordova()
static pickContact(): Promise<any> { return; }
}
static pickContact(): Promise<any> {return; }
}

4
src/plugins/plugin.ts
View File

@ -325,13 +325,13 @@ export function CordovaProperty(target: Function, key: string, descriptor: Typed
* @param descriptor
* @constructor
*/
export function InstanceProperty(target: Function, key: string, descriptor: TypedPropertyDescriptor<any>) {
export function InstanceProperty(target: any, key: string, descriptor: TypedPropertyDescriptor<any>) {
descriptor.get = function() {
return this._objectInstance[key];
};
descriptor.set = function(...args: any[]) {
return this._objectInstance[key] = args[0];
this._objectInstance[key] = args[0];
};
return descriptor;