Quickstart

dependencies: [
    .package(url: "https://github.com/arpwal/contactsmanager-ios.git", from: "<latest-version>")
]

import ContactsManager

// Create user information
let userInfo = UserInfo(
    userId: "user123",
    fullName: "John Doe",
    email: "john@example.com",
    phone: "+1234567890"
)

// Initialize with API key and user info (NOT RECOMMENDED for production)
try await ContactsService.shared.initialize(
    withAPIKey: "your-api-key",
    token: nil, // Will generate token client-side with security warning
    userInfo: userInfo,
    options: ContactsManagerOptions(
        verboseLogging: true,
        autoSyncEnabled: true
    )
)

npm install @contactsmanager/rn
# or
yarn add @contactsmanager/rn

import { initialize, isInitialized } from '@contactsmanager/rn';

// Create user information
const userInfo = {
  userId: "user123",
  fullName: "John Doe",
  email: "john@example.com",
  phone: "+1234567890"
};

// Check if already initialized
const alreadyInitialized = await isInitialized();

// Initialize with API key and user info (NOT RECOMMENDED for production)
const result = await initialize("your-api-key", userInfo, null, {
  verboseLogging: true,
  autoSyncEnabled: true
});

#import <ContactsManager/ContactsManager.h>

// Create user info
CMUserInfo *userInfo = [[CMUserInfo alloc] init];
userInfo.userId = @"user123";
userInfo.email = @"user@example.com";
userInfo.phone = @"+1234567890";
userInfo.fullName = @"John Doe";

// Initialize with options
CMContactsManagerOptions *options = [CMContactsManagerOptions defaultOptions];
options.verboseLogging = YES;
options.autoSyncEnabled = YES;

// Initialize the service (NOT RECOMMENDED for production)
[[CMContactService sharedInstance] initializeWithAPIKey:@"your_api_key"
                                                  token:nil // Will generate client-side
                                               userInfo:userInfo
                                                options:options
                                             completion:^(BOOL success, NSError * _Nullable error) {
    if (success) {
        NSLog(@"ContactsManager initialized successfully");
    } else {
        NSLog(@"Initialization failed: %@", error.localizedDescription);
    }
}];

// Initialize the library
private val contactService by lazy { ContactService.getInstance(context) }

// Create user info
val userInfo = UserInfo(
    userId = "user-123",
    displayName = "John Doe",
    email = "john@example.com",
    phone = "+1234567890"
)

// Create options
val options = CMContactsManagerOptions.defaultOptions().apply {
    verboseLogging = true
    autoSyncEnabled = true
}

// Initialize the service (NOT RECOMMENDED for production)
val initResult = contactService.initialize(
    apiKey = "your-api-key",
    userInfo = userInfo,
    options = options
)

if (initResult.isSuccess) {
    // Service initialized successfully
    val contacts = initResult.data
} else {
    // Handle initialization error
    val error = initResult.error
}

pip install contactsmanager

from contactsmanager import ContactsManagerClient, UserInfo, DeviceInfo

# Initialize the client
client = ContactsManagerClient(
    api_key="your-api-key",
    api_secret="your-api-secret", 
    org_id="your-org-id"
)

# Create user info
user_info = UserInfo(
    user_id="user-123",
    full_name="John Doe",
    email="john@example.com",  # Optional but recommended
    phone="+1234567890",       # Optional but recommended
    avatar_url="https://...",  # Optional
    metadata={"key": "value"}  # Optional
)

# Create device info (optional)
device_info = DeviceInfo(
    device_name="iPhone 15",
    os_version="iOS 17.5",
    app_version="1.0.0"
)

# Create/update user and get token (first time or when user data changes)
response = client.create_user(
    user_info=user_info,
    device_info=device_info,
    expiry_seconds=86400  # 24 hours
)

# Use the token for client SDK initialization
token = response.token
user_data = response.user  # Created/updated user information

# For subsequent logins, generate a new token for existing users
token_data = client.generate_token(
    user_id="user-123",
    device_info={"device_name": "iPhone 15", "os_version": "iOS 17.5"},
    expiration_seconds=86400  # 24 hours
)

# The token to be used in client SDK initialization
token = token_data["token"]

npm install @contactsmanager/server

import { ContactsManagerClient } from '@contactsmanager/server';

// Initialize the client
const client = new ContactsManagerClient({
  apiKey: 'your-api-key',
  apiSecret: 'your-api-secret',
  orgId: 'your-org-id'
});

// Create/update user and get token (first time or when user data changes)
async function createUserAndGetToken() {
  const userInfo = {
    userId: 'user-123',
    fullName: 'John Doe',
    email: 'john@example.com',      // Optional but recommended
    phone: '+1234567890',           // Optional but recommended
    avatarUrl: 'https://...',       // Optional
    metadata: { key: 'value' }      // Optional
  };

  const deviceInfo = {
    deviceName: 'iPhone 15',
    osVersion: 'iOS 17.5',
    appVersion: '1.0.0'
  };

  const response = await client.createUser(
    userInfo,
    deviceInfo,
    86400  // 24 hours expiry
  );

  // Use the token for client SDK initialization
  const token = response.token;
  const userData = response.user;  // Created/updated user information
  
  return { token, userData };
}

// For subsequent logins, generate a new token for existing users
async function generateUserToken() {
  const tokenData = await client.generateToken({
    userId: 'user-123',
    deviceInfo: { deviceName: 'iPhone 15', osVersion: 'iOS 17.5' },
    expirationSeconds: 86400 // 24 hours
  });
  
  // The token to be used in client SDK initialization
  const token = tokenData.token;
  return token;
}

dependencies: [
    .package(url: "https://github.com/arpwal/contactsmanager-ios.git", from: "<latest-version>")
]

import ContactsManager

// Initialize the SDK with server-generated token (RECOMMENDED)
try await ContactsService.shared.initialize(
    withToken: "server-generated-token",
    options: ContactsManagerOptions(
        verboseLogging: false,
        autoSyncEnabled: true
    )
)

npm install @contactsmanager/rn
# or
yarn add @contactsmanager/rn

npx expo prebuild

cd ios && pod install && cd ..

<key>NSContactsUsageDescription</key>
<string>We need access to your contacts to enable social features</string>

<!-- Required for accessing contacts -->
<uses-permission android:name="android.permission.READ_CONTACTS" />

<!-- Required for network operations -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

buildscript {
    ext {
        minSdkVersion = 23
    }
}

import { initializeWithToken, isInitialized } from '@contactsmanager/rn';

// Check if already initialized
const alreadyInitialized = await isInitialized();

// Initialize with server-generated token (RECOMMENDED)
const result = await initializeWithToken("server-generated-token", {
  verboseLogging: false,
  autoSyncEnabled: true
});

// Basic Usage Example
import { requestContactsAccess, hasContactsReadAccess, getContacts } from '@contactsmanager/rn';

const requestAccess = async () => {
  try {
    const { granted } = await requestContactsAccess();
    if (granted) {
      const hasReadAccess = await hasContactsReadAccess();
      if (hasReadAccess) {
        const contacts = await getContacts();
        console.log(`Retrieved ${contacts.length} contacts`);
      }
    }
  } catch (error) {
    console.error('Error accessing contacts:', error);
  }
};

<key>NSContactsUsageDescription</key>
<string>We need access to contacts to enable social features.</string>

#import <ContactsManager/ContactsManager.h>

// Initialize with options (optional)
CMContactsManagerOptions *options = [CMContactsManagerOptions defaultOptions];
options.verboseLogging = NO;
options.autoSyncEnabled = YES;

// Initialize the service with server-generated token (RECOMMENDED)
[[CMContactService sharedInstance] initializeWithToken:@"server-generated-token"
                                                options:options // Optional
                                             completion:^(BOOL success, NSError * _Nullable error) {
    if (success) {
        NSLog(@"ContactsManager initialized successfully");
    } else {
        NSLog(@"Initialization failed: %@", error.localizedDescription);
    }
}];

implementation("io.contactsmanager:contactsmanager:1.0.5")

<!-- Required for accessing contacts -->
<uses-permission android:name="android.permission.READ_CONTACTS" />

<!-- Required for network operations -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

// Initialize the library
private val contactService by lazy { ContactService.getInstance(context) }

// Create options
val options = CMContactsManagerOptions.defaultOptions().apply {
    verboseLogging = false
    autoSyncEnabled = true
}

// Initialize the service with server-generated token (RECOMMENDED)
val initResult = contactService.initializeWithToken(
    token = "server-generated-token",
    options = options
)

if (initResult.isSuccess) {
    // Service initialized successfully
    val userInfo = initResult.data
} else {
    // Handle initialization error
    val error = initResult.error
}