View source for Phonenumber class

{{CGscriptClass_Template
|Name=<nowiki>Phonenumber</nowiki>
|Description=<nowiki>A phonenumber</nowiki>
|InheritsFrom=Array|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>phoneArray</nowiki>|Description=<nowiki>Array of type, number, call-prefix[, country isocode]</nowiki>}}
|Description=<nowiki>Create new phonenumber</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Any</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>predicate</nowiki>|Description=<nowiki>A function that takes 1 parameter of the types in the array, and return true/false</nowiki>}}
|Description=<nowiki>Return true if the array contains the element using the given function.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Clear</nowiki>|Inherited=array|Description=<nowiki>Remove all items in array</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Contains</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=object|Name=<nowiki>element</nowiki>|Description=<nowiki>Element to check for</nowiki>}}
|Description=<nowiki>Return true if the array contains the element using the normal equal operator.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Except</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>elements</nowiki>|Description=<nowiki>Elements to remove</nowiki>}}
|Description=<nowiki>Return all elements that does not exist in the other collection.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>First</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>selector</nowiki>|Description=<nowiki>A function to test each element for a condition.</nowiki>}}
|Description=<nowiki>Returns the first element in a sequence that satisfies a specified condition.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>FirstOrDefault</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>selector</nowiki>|Description=<nowiki>A function to test each element for a condition.</nowiki>}}
|Description=<nowiki>Returns the first element in a sequence that satisfies a specified condition or empty if not found.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Foreach</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>function</nowiki>|Description=<nowiki>A function that takes 1 parameter of the types in the array, and an optional 2nd parameter that is the index</nowiki>}}
|Description=<nowiki>Filters a sequence of values based on a predicate.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>Frequency</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>number</nowiki>|Description=<nowiki>The number to search for</nowiki>}}
|Description=<nowiki>Counts the number of times a given Number object exists in the Array. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}}
|Description=<nowiki>Backward-compatible indexer</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>IndexOf</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=object|Name=<nowiki>element</nowiki>|Description=<nowiki>Element to search for</nowiki>}}
|Description=<nowiki>Return index of the given element using ==, or -1.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>IndexOfObject</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=object|Name=<nowiki>element</nowiki>|Description=<nowiki>Element to search for</nowiki>}}
|Description=<nowiki>Return index of the given element using references, or -1.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>IsCharacterArray</nowiki>|Inherited=array|Description=<nowiki>check if array is an array of characters</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>IsNumericArray</nowiki>|Inherited=array|Description=<nowiki>check if array is an array of integer numbers</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>IsStringArray</nowiki>|Inherited=array|Description=<nowiki>check if array is an array of string</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>OrderBy</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>comparer</nowiki>|Description=<nowiki>Function that compares two objects of the same type. Must return a signed integer that indicates the relative values of first param A and second param B. Value Less than 0 : A is less than B.Value 0 : A equals B.Value Greater than 0 : A is greater than B.It can also be a function that takes 1 parameter and returns a string or number.</nowiki>}}
|Description=<nowiki>Sorts the elements of a sequence in ascending order by using a specified comparer.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ParseNumber</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>value</nowiki>|Description=<nowiki>Formatted value</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>CountryCallingCode</nowiki>|Description=<nowiki>Digit(s) dial after the +</nowiki>}}
|Description=<nowiki>Parse number from formatted value</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ParseNumber</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>value</nowiki>|Description=<nowiki>Formatted value</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>countryIso</nowiki>|Description=<nowiki>Iso code of the country the number is in</nowiki>}}
|Description=<nowiki>Parse number from formatted value</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Randomize</nowiki>|Inherited=array|Obsolete=1
|Description=<nowiki>[Obsolete] Randomize the order of the elements in the current array. Multiple calls to this may return the same randomization, use a Random object to preserve randomization over multiple calls</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Randomize</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=Random|Name=<nowiki>random</nowiki>|Description=<nowiki>Random object</nowiki>}}
|Description=<nowiki>Randomize the order of the elements in the current array.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Reverse</nowiki>|Inherited=array|Description=<nowiki>Returns an array with all the elements in the opposite order.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Select</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>selector</nowiki>|Description=<nowiki>A transform function to apply to each element.</nowiki>}}
|Description=<nowiki>Projects each element of a sequence into a new form.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>SelectMany</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>selector</nowiki>|Description=<nowiki>A transform function to get each sub array.</nowiki>}}
|Description=<nowiki>Projects each array element of a sequence into a new form.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to set</nowiki>}}
|Description=<nowiki>Backward-compatible indexer</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Skip</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>n</nowiki>|Description=<nowiki>How many elements to skip</nowiki>}}
|Description=<nowiki>Get all but the n first elements.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Take</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>n</nowiki>|Description=<nowiki>How many elements to take</nowiki>}}
|Description=<nowiki>Get the n first elements.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>ToDictionary</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>keySelector</nowiki>|Description=<nowiki>A transform function to get the key of each element.</nowiki>}}
|Description=<nowiki>Return a dictionary with the elements of the array.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>ToDictionary</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>keySelector</nowiki>|Description=<nowiki>A transform function to get the key of each element.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Function|Name=<nowiki>valueSelector</nowiki>|Description=<nowiki>A transform function to get the value of each element.</nowiki>}}
|Description=<nowiki>Return a dictionary with the elements of the array.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=Array|Description=<nowiki>The string representation of the object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>UpdateNumber</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>areaCode</nowiki>|Description=<nowiki>New areacode</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>number</nowiki>|Description=<nowiki>New number</nowiki>}}
|Description=<nowiki>Update number from formatted value</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Where</nowiki>|Inherited=array|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>predicate</nowiki>|Description=<nowiki>A function that takes 1 parameter of the types in the array, and an optional 2nd parameter that is the index and return true/false</nowiki>}}
|Description=<nowiki>Filters a sequence of values based on a predicate.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Average</nowiki>|HasGetter=1|Inherited=array|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>CountryCallingCode</nowiki>|HasGetter=1|Description=<nowiki>Digit(s) dial after the +</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CountryIso</nowiki>|HasGetter=1|Description=<nowiki>Iso code of the country the number is in</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Extension</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Extension part of the phonenumber</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>FormattedNumber</nowiki>|HasGetter=1|Description=<nowiki>Number formatted for display</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Max</nowiki>|HasGetter=1|Inherited=array|Description=<nowiki>Largest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Min</nowiki>|HasGetter=1|Inherited=array|Description=<nowiki>Smallest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Sum</nowiki>|HasGetter=1|Inherited=array|Description=<nowiki>Sum of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
}}

=== <span style="color:#DF8621">'''Examples'''</span> ===
<source lang="javascript">
//Add new number
User user = User_getUserByResourceId(2014917);
user.PhoneNumbers = {{PhoneNumber_Type_NotIdentified, "88888888", 45}};
user.Save();
print(user.PhoneNumbers[0].FormattedNumber);//88888888
print(user.PhoneNumbers[0].CountryCallingCode);//45
print(user.PhoneNumbers[0].CountryIso);//dk
print(user.PhoneNumbers[0].Extension);// empty
</source>

<source lang="javascript">
//ParseNumber
User user = User_getUserByResourceId(2014917);
if (user.PhoneNumbers.Count > 0)
{
	
	string formattedNumber = "88888888";
	string countryIso = "vn";
	user.PhoneNumbers[0].ParseNumber(formattedNumber, countryIso);
	user.PhoneNumbers[0].Extension = "1";
	user.Save();
	print(user.PhoneNumbers[0].FormattedNumber);//88888888#1
	print(user.PhoneNumbers[0].CountryCallingCode);//84
	print(user.PhoneNumbers[0].CountryIso);//vn
	print(user.PhoneNumbers[0].Extension);//1
}
</source>

<source lang="javascript">
//UpdateNumber
User user = User_getUserByResourceId(2014917);
if (user.PhoneNumbers.Count > 0)
{
	
	string areaCode = "2";
	string formattedNumber = "88888888";
	user.PhoneNumbers[0].UpdateNumber(areaCode,formattedNumber);
	user.Save();
	print(user.PhoneNumbers[0].FormattedNumber);//88888888#1
	print(user.PhoneNumbers[0].CountryCallingCode);//84
	print(user.PhoneNumbers[0].CountryIso);//vn
	print(user.PhoneNumbers[0].Extension);//1
}
</source>