Difference between revisions of "Phonenumber class"

From Catglobe Wiki
Jump to: navigation, search
Line 6: Line 6:
 
{{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>}}
 
{{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>}}
 
|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=
 
{{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>}}
 
{{CGscriptParameters_Template|Type=object|Name=<nowiki>element</nowiki>|Description=<nowiki>Element to check for</nowiki>}}
Line 18: Line 19:
 
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>selector</nowiki>|Description=<nowiki>A function to test each element for a condition.</nowiki>}}
 
{{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>}}
 
|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=
 
{{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>}}
 
{{CGscriptParameters_Template|Type=number|Name=<nowiki>number</nowiki>|Description=<nowiki>The number to search for</nowiki>}}
Line 26: Line 30:
 
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>IndexOf</nowiki>|Inherited=array|Parameters=
 
{{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>}}
 
{{CGscriptParameters_Template|Type=object|Name=<nowiki>element</nowiki>|Description=<nowiki>Element to search for</nowiki>}}
|Description=<nowiki>Return index of the given element, or -1.</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>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>IsNumericArray</nowiki>|Inherited=array|Description=<nowiki>check if array is an array of integer numbers</nowiki>}}
Line 39: Line 46:
 
{{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>}}
 
{{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>}}
 
|Description=<nowiki>Parse number from formatted value</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Randomize</nowiki>|Inherited=array|Description=<nowiki>Randomize the order of the elements in the current array.</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>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=
 
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Select</nowiki>|Inherited=array|Parameters=
Line 86: Line 97:
 
//Add new number
 
//Add new number
 
User user = User_getUserByResourceId(2014917);
 
User user = User_getUserByResourceId(2014917);
user.PhoneNumbers = {{PhoneNumber_Type_NotIdentified, "29568978", 45}};
+
user.PhoneNumbers = {{PhoneNumber_Type_NotIdentified, "88888888", 45}};
 
user.Save();
 
user.Save();
print(user.PhoneNumbers[0].FormattedNumber);//29568978
+
print(user.PhoneNumbers[0].FormattedNumber);//88888888
 
print(user.PhoneNumbers[0].CountryCallingCode);//45
 
print(user.PhoneNumbers[0].CountryCallingCode);//45
 
print(user.PhoneNumbers[0].CountryIso);//dk
 
print(user.PhoneNumbers[0].CountryIso);//dk
Line 100: Line 111:
 
{
 
{
 
 
string formattedNumber = "29568979";
+
string formattedNumber = "88888888";
 
string countryIso = "vn";
 
string countryIso = "vn";
 
user.PhoneNumbers[0].ParseNumber(formattedNumber, countryIso);
 
user.PhoneNumbers[0].ParseNumber(formattedNumber, countryIso);
 
user.PhoneNumbers[0].Extension = "1";
 
user.PhoneNumbers[0].Extension = "1";
 
user.Save();
 
user.Save();
print(user.PhoneNumbers[0].FormattedNumber);//29568979#1
+
print(user.PhoneNumbers[0].FormattedNumber);//88888888#1
 
print(user.PhoneNumbers[0].CountryCallingCode);//84
 
print(user.PhoneNumbers[0].CountryCallingCode);//84
 
print(user.PhoneNumbers[0].CountryIso);//vn
 
print(user.PhoneNumbers[0].CountryIso);//vn
Line 119: Line 130:
 
 
 
string areaCode = "2";
 
string areaCode = "2";
string formattedNumber = "29568999";
+
string formattedNumber = "88888888";
 
user.PhoneNumbers[0].UpdateNumber(areaCode,formattedNumber);
 
user.PhoneNumbers[0].UpdateNumber(areaCode,formattedNumber);
 
user.Save();
 
user.Save();
print(user.PhoneNumbers[0].FormattedNumber);//229568999#1
+
print(user.PhoneNumbers[0].FormattedNumber);//88888888#1
 
print(user.PhoneNumbers[0].CountryCallingCode);//84
 
print(user.PhoneNumbers[0].CountryCallingCode);//84
 
print(user.PhoneNumbers[0].CountryIso);//vn
 
print(user.PhoneNumbers[0].CountryIso);//vn

Revision as of 08:05, 13 June 2024

Phonenumber


A phonenumber

Parent class

Inherits from Array

Methods

  • (From array) bool Any(Function predicate "A function that takes 1 parameter of the types in the array, and return true/false") - Return true if the array contains the element using the given function.
  • (From array) Empty Clear() - Remove all items in array
  • (From array) bool Contains(object element "Element to check for") - Return true if the array contains the element using the normal equal operator.
  • (From array) array Except(array elements "Elements to remove") - Return all elements that does not exist in the other collection.
  • (From array) object First(Function selector "A function to test each element for a condition.") - Returns the first element in a sequence that satisfies a specified condition.
  • (From array) object FirstOrDefault(Function selector "A function to test each element for a condition.") - Returns the first element in a sequence that satisfies a specified condition or empty if not found.
  • (From array) Empty Foreach(Function function "A function that takes 1 parameter of the types in the array, and an optional 2nd parameter that is the index") - Filters a sequence of values based on a predicate.
  • (From array) int Frequency(number number "The number to search for") - Counts the number of times a given Number object exists in the Array. Can only use if all the elements are of type Number
  • object this[] { get; }(int index "Index") - Backward-compatible indexer
  • (From array) int IndexOf(object element "Element to search for") - Return index of the given element using ==, or -1.
  • (From array) int IndexOfObject(object element "Element to search for") - Return index of the given element using references, or -1.
  • (From array) bool IsCharacterArray() - check if array is an array of characters
  • (From array) bool IsNumericArray() - check if array is an array of integer numbers
  • (From array) bool IsStringArray() - check if array is an array of string
  • (From array) array OrderBy(Function comparer "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.") - Sorts the elements of a sequence in ascending order by using a specified comparer.
  • Empty ParseNumber(string value "Formatted value", int CountryCallingCode "Digit(s) dial after the +") - Parse number from formatted value
  • Empty ParseNumber(string value "Formatted value", string countryIso "Iso code of the country the number is in") - Parse number from formatted value
  • (From array) Empty Randomize() - [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
  • (From array) Empty Randomize(Random random "Random object") - Randomize the order of the elements in the current array.
  • (From array) array Reverse() - Returns an array with all the elements in the opposite order.
  • (From array) array Select(Function selector "A transform function to apply to each element.") - Projects each element of a sequence into a new form.
  • (From array) array SelectMany(Function selector "A transform function to get each sub array.") - Projects each array element of a sequence into a new form.
  • Empty this[] { set; }(int index "Index", object value "Value to set") - Backward-compatible indexer
  • (From array) array Skip(int n "How many elements to skip") - Get all but the n first elements.
  • (From array) array Take(int n "How many elements to take") - Get the n first elements.
  • (From array) Dictionary ToDictionary(Function keySelector "A transform function to get the key of each element.") - Return a dictionary with the elements of the array.
  • (From array) Dictionary ToDictionary(Function keySelector "A transform function to get the key of each element.", Function valueSelector "A transform function to get the value of each element.") - Return a dictionary with the elements of the array.
  • (From Array) string ToString() - The string representation of the object.
  • Empty UpdateNumber(string areaCode "New areacode", string number "New number") - Update number from formatted value
  • (From array) array Where(Function predicate "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") - Filters a sequence of values based on a predicate.

Properties

  • (From array) number Average { get; } - Average of the objects in the Array object. Can only use if all the elements are of type Number
  • int CountryCallingCode { get; } - Digit(s) dial after the +
  • string CountryIso { get; } - Iso code of the country the number is in
  • string Extension { get; set; } - Extension part of the phonenumber
  • string FormattedNumber { get; } - Number formatted for display
  • (From array) number Max { get; } - Largest of all the objects in the Array object. Can only use if all the elements are of type Number
  • (From array) number Min { get; } - Smallest of all the objects in the Array object. Can only use if all the elements are of type Number
  • string ObjectTypeName { get; } - The name of the type of object.
  • (From array) number Sum { get; } - Sum of all the objects in the Array object. Can only use if all the elements are of type Number
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.


Examples

//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
//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
}
//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
}