contact
Contents
Contact 는 HSP 에서 기본으로 제공하는 API로 별도의 설정 없이 사용 가능하며 연락처 정보를 추가하거나 불러오는 기능을 제공한다.
add
add 는 주소록 정보를 추가하는 기능이다. 이때 사용자 이름, 이메일주소, 전화번호를 입력할 수 있다.
options
| 필드 | 설명 | M/O |
|---|---|---|
| firstName | 이름 | M |
| lastName | 성 | M |
| 이메일 주소 | O | |
| mobile | 핸드폰 번호 | O |
| work | 회사 전화 번호 | O |
| home | 집 전화 번호 | O |
Example
let infoParam = DAPContactAddParam()
infoParam.firstName = "길동"
infoParam.lastName = "홍"
infoParam.email = "gildong.hone@test.com"
infoParam.mobile = "01012341234"
DAPContact.add(infoParam, completion: { resultDict in
// TODO
}, failure: { error in
// TODO
})
infoParam.firstName = "길동"
infoParam.lastName = "홍"
infoParam.email = "gildong.hone@test.com"
infoParam.mobile = "01012341234"
DAPContact.add(infoParam, completion: { resultDict in
// TODO
}, failure: { error in
// TODO
})
DAPContactAddParam *infoParam = [DAPContactAddParam new];
infoParam.firstName = @"길동";
infoParam.lastName = @"홍";
infoParam.email = @"gildong.hone@test.com";
infoParam.mobile = @"01012341234";
[DAPContact add:infoParam completion:^(NSDictionary *resultDict) {
// TODO
} failure:^(NSError *error) {
// TODO
}];
infoParam.firstName = @"길동";
infoParam.lastName = @"홍";
infoParam.email = @"gildong.hone@test.com";
infoParam.mobile = @"01012341234";
[DAPContact add:infoParam completion:^(NSDictionary *resultDict) {
// TODO
} failure:^(NSError *error) {
// TODO
}];
find
find 는 등록되어 있는 주소록에 전화번호, 이름, 이메일 주소를 이용하여 원하는 주소록을 얻을 수 있다.
options
| 필드 | 설명 | M/O |
|---|---|---|
| filterDisplayName | 이름 검색 여부 | O |
| filterPhoneNumbers | 전화번호 검색 여부 | O |
| filterEmail | 이메일 검색 여부 | O |
| searchWord | 검색어 | O |
Example
let infoParam = DAPContactFindParam()
infoParam.filterDisplayName = true
infoParam.filterPhoneNumbers = true
infoParam.filterEmail = true
infoParam.searchWord = "길동"
DAPContact.find(infoParam, completion: { resultDict in
// TODO
}, failure: { error in
// TODO
})
infoParam.filterDisplayName = true
infoParam.filterPhoneNumbers = true
infoParam.filterEmail = true
infoParam.searchWord = "길동"
DAPContact.find(infoParam, completion: { resultDict in
// TODO
}, failure: { error in
// TODO
})
DAPContactFindParam *infoParam = [DAPContactFindParam new];
infoParam.filterDisplayName = YES;
infoParam.filterPhoneNumbers = YES;
infoParam.filterEmail = YES;
infoParam.searchWord = @"길동";
[DAPContact find:infoParam completion:^(NSDictionary *resultDict) {
// TODO
} failure:^(NSError *error) {
// TODO
}];
infoParam.filterDisplayName = YES;
infoParam.filterPhoneNumbers = YES;
infoParam.filterEmail = YES;
infoParam.searchWord = @"길동";
[DAPContact find:infoParam completion:^(NSDictionary *resultDict) {
// TODO
} failure:^(NSError *error) {
// TODO
}];
remove
remove 는 등록되어 있는 주소록을 삭제하는 기능이다. 삭제할 기준 값은 find 를 통해 얻은 id 값으로 삭제 할 수 있다.
options
| 필드 | 설명 | M/O |
|---|---|---|
| contactId | id값은 find로 얻은 개별 주소록에 Primary Key 값이다. | M |
Example
let contactId = "1"
DAPContact.remove(contactId, completion: { resultDict in
// TODO
}, failure: { error in
// TODO
})
DAPContact.remove(contactId, completion: { resultDict in
// TODO
}, failure: { error in
// TODO
})
NSString *contactId = @"1";
[DAPContact remove:contactId completion:^(NSDictionary *resultDict) {
// TODO
} failure:^(NSError *error) {
// TODO
}];
[DAPContact remove:contactId completion:^(NSDictionary *resultDict) {
// TODO
} failure:^(NSError *error) {
// TODO
}];
Error Code
| Code | Cause | Comment |
|---|---|---|
| E10200 | 파라메터 값이 잘못되어 있을 경우 | |
| E10201 | 전달된 액션 값이 알 수 없는 액션일 경우 | |
| E10202 | 주소록 정보 추가시 성이 잘못되어 있을 경우 | |
| E10203 | 주소록 정보 추가시 이름이 잘못되어 있을 경우 | |
| E10204 | 주소록 삭제시 개별 주소록에 Primary Key 값이 잘못되어 있을 경우 | |
| E10250 | 실행 중 오류가 발생 되었을 경우 | |
| E10299 | 알 수 없는 오류가 발생 되었을 경우 | |