Skip to content

New GSharedContactPhoneNumberObj

Spencer Varney edited this page Dec 9, 2016 · 4 revisions

New-GSharedContactPhoneNumberObj

SYNOPSIS

Create a new shared contact phone number object.

SYNTAX

New-GSharedContactPhoneNumberObj [[-Label] <String>] [[-Rel] <PhoneNumberRelEnum>] [[-Uri] <String>]
 [[-Primary] <Boolean>] [-Text] <String> [-WhatIf] [-Confirm]

DESCRIPTION

Create a new shared contact phone number object.

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> New-GSharedContactPhoneNumberObj

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-Label

A simple string value used to name this phone number. In most cases, @label is not necessary as @rel uniquely identifies a number and allows UIs to display a proper label such as "Mobile", "Home", "Work", etc. However, in the case where one person has (for example) multiple mobile phones, this property can be used to disambiguate them.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-Rel

A programmatic value that identifies the type of phone number

Possible values: assistant, callback, car, company_main, fax, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager

Type: PhoneNumberRelEnum
Parameter Sets: (All)
Aliases: 
Accepted values: assistant, callback, car, company_main, fax, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager

Required: False
Position: 1
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-Uri

An optional "tel URI" used to represent the number in a formal way, useful for programmatic access, such as a VoIP/PSTN bridge. See RFC 3966 for more information on tel URIs.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-Primary

When multiple phone number extensions appear in a contact kind, indicates which is primary. At most one phone number may be primary. Default value is "false".

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 3
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-Text

Human-readable phone number; may be in any telephone number format. Leading and trailing whitespace is insignificant. Newlines within the string are also insignificant, and may be removed or flattened out to a single space.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 4
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

OUTPUTS

NOTES

Part of the gShell Project, relating to the Google Shared Contacts API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally