Class PhoneField

PhoneField

Deprecated.Instead, use the People API advanced service

A phone number field in a Contact.

Methods

Method Return type Brief description
getLabel()
Object Gets the label for this field.
isPrimary()
Boolean Gets whether this is the primary field value.
setAsPrimary()
PhoneField Sets this field to primary.
setLabel(field)
PhoneField Sets the label of this field.
setLabel(label)
PhoneField Sets the label of this field.

Detailed documentation

getLabel()

Gets the label for this field. This may be a Field, ExtendedField, or a String.

 // 
  
 Logs 
  
 the 
  
 label 
  
 for 
  
 all 
  
 the 
  
 address 
  
 fields 
  
 associated 
  
 with 
  
 contact 
 // 
  
 'John Doe' 
 . 
  
 This 
  
 method 
  
 can 
  
 be 
  
 similarly 
  
 called 
  
 for 
  
 any 
  
 field 
  
 that 
  
 has 
 // 
  
 a 
  
 label 
 . 
 var 
  
 contacts 
  
 = 
  
 ContactsApp 
 . 
 getContactsByName 
 ( 
 'John Doe' 
 ); 
 var 
  
 addressFields 
  
 = 
  
 contacts 
 [ 
 0 
 ] 
 . 
 getAddresses 
 (); 
 for 
  
 ( 
 var 
  
 i 
  
 = 
  
 0 
 ; 
  
 i 
 < 
 addressFields 
 . 
 length 
 ; 
  
 i 
 ++ 
 ) 
  
 { 
  
 Logger 
 . 
 log 
 ( 
 addressFields 
 [ 
 i 
 ] 
 . 
 getLabel 
 ()); 
 }

Return

Object — the label for this field

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.google.com/m8/feeds

isPrimary()

Gets whether this is the primary field value.

 // 
  
 Logs 
  
 whether 
  
 or 
  
 not 
  
 the 
  
 first 
  
 address 
  
 field 
  
 associated 
  
 with 
  
 contact 
 // 
  
 'John Doe' 
  
 is 
  
 labeled 
  
 as 
  
 primary 
 . 
  
 This 
  
 method 
  
 can 
  
 be 
  
 similarly 
  
 called 
 // 
  
 for 
  
 any 
  
 field 
 . 
 var 
  
 contacts 
  
 = 
  
 ContactsApp 
 . 
 getContactsByName 
 ( 
 'John Doe' 
 ); 
 var 
  
 addressFields 
  
 = 
  
 contacts 
 [ 
 0 
 ] 
 . 
 getAddresses 
 (); 
 Logger 
 . 
 log 
 ( 
 addressFields 
 [ 
 0 
 ] 
 . 
 isPrimary 
 ());

Return

Boolean — whether this is primary

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.google.com/m8/feeds

setAsPrimary()

Sets this field to primary.

 // 
  
 Sets 
  
 the 
  
 the 
  
 first 
  
 address 
  
 field 
  
 associated 
  
 with 
  
 contact 
  
 'John Doe' 
 // 
  
 as 
  
 primary 
 . 
  
 This 
  
 method 
  
 can 
  
 be 
  
 similarly 
  
 called 
  
 for 
  
 any 
  
 field 
 . 
 var 
  
 contacts 
  
 = 
  
 ContactsApp 
 . 
 getContactsByName 
 ( 
 'John Doe' 
 ); 
 var 
  
 addressFields 
  
 = 
  
 contacts 
 [ 
 0 
 ] 
 . 
 getAddresses 
 (); 
 addressFields 
 [ 
 0 
 ] 
 . 
 setAsPrimary 
 ();

Return

PhoneField — this FieldValue for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.google.com/m8/feeds

setLabel(field)

Sets the label of this field.

 // 
  
 Sets 
  
 the 
  
 label 
  
 to 
  
 'Work' 
  
 for 
  
 the 
  
 first 
  
 address 
  
 field 
  
 associated 
 // 
  
 with 
  
 contact 
  
 'John Doe' 
 . 
  
 This 
  
 method 
  
 can 
  
 be 
  
 similarly 
  
 called 
  
 for 
  
 any 
 // 
  
 field 
  
 that 
  
 has 
  
 a 
  
 label 
 . 
 var 
  
 contacts 
  
 = 
  
 ContactsApp 
 . 
 getContactsByName 
 ( 
 'John Doe' 
 ); 
 var 
  
 addressFields 
  
 = 
  
 contacts 
 [ 
 0 
 ] 
 . 
 getAddresses 
 (); 
 addressFields 
 [ 
 0 
 ] 
 . 
 setLabel 
 ( 
 ContactsApp 
 . 
 Field 
 . 
 WORK_ADDRESS 
 );

Parameters

Name Type Description
field
Field the new standard label

Return

PhoneField — this FieldValue for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.google.com/m8/feeds

setLabel(label)

Sets the label of this field.

 // 
  
 Sets 
  
 the 
  
 label 
  
 to 
  
 'Apartment' 
  
 for 
  
 the 
  
 first 
  
 address 
  
 field 
  
 associated 
 // 
  
 with 
  
 contact 
  
 'John Doe' 
 . 
  
 This 
  
 method 
  
 can 
  
 be 
  
 similarly 
  
 called 
  
 for 
  
 any 
 // 
  
 field 
  
 that 
  
 has 
  
 a 
  
 label 
 . 
 var 
  
 contacts 
  
 = 
  
 ContactsApp 
 . 
 getContactsByName 
 ( 
 'John Doe' 
 ); 
 var 
  
 addressFields 
  
 = 
  
 contacts 
 [ 
 0 
 ] 
 . 
 getAddresses 
 (); 
 addressFields 
 [ 
 0 
 ] 
 . 
 setLabel 
 ( 
 'Apartment' 
 );

Parameters

Name Type Description
label
String the new label for this field

Return

PhoneField — this field, useful for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.google.com/m8/feeds

Deprecated methods