MicrosoftPlaces.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>MicrosoftPlaces</name> </assembly> <members> <member name="M:MicrosoftPlaces.BasePSCmdlet.TraceError(System.Management.Automation.ErrorRecord)"> <summary> Traces the error. </summary> <param name="errorRecord">The error record.</param> </member> <member name="M:MicrosoftPlaces.BasePSCmdlet.TraceInvalidArgument(System.String)"> <summary> Traces invalid argument errors. </summary> <param name="message">The message to associate with the invalid argument error.</param> </member> <member name="M:MicrosoftPlaces.BasePSCmdlet.GetServiceHostUri(System.String,System.String)"> <summary> Gets the service host Uri. </summary> <returns> servicehost Uri.</returns> </member> <member name="M:MicrosoftPlaces.BasePSCmdlet.InitializeServiceParameters"> <summary> Init common cmdlet configuration and generate the access token. </summary> </member> <member name="T:MicrosoftPlaces.CmdletConfiguration"> <summary> This class stores the settings data deserialized from CmdletSettings.json. </summary> </member> <member name="P:MicrosoftPlaces.CmdletConfiguration.EnvironmentConfigurations"> <summary> List of Environment Configurations. </summary> </member> <member name="M:MicrosoftPlaces.CmdletSession.DisconnectCmdletSession"> <summary> Closes the current session cleaning variables and removing session file if exists. </summary> </member> <member name="F:MicrosoftPlaces.Constants.CmdletSettings"> <summary> The json file with all the settings. </summary> </member> <member name="F:MicrosoftPlaces.Constants.SessionCacheFilename"> <summary> The session cache filename. </summary> </member> <member name="F:MicrosoftPlaces.Constants.AuthorizationHeaderName"> <summary> The header for the Authorization. </summary> </member> <member name="F:MicrosoftPlaces.Constants.UserAgentHeaderName"> <summary> The header for the user agent. </summary> </member> <member name="F:MicrosoftPlaces.Constants.HostHeaderName"> <summary> The header for the host. </summary> </member> <member name="F:MicrosoftPlaces.Constants.LocalHostHeaderValue"> <summary> The value to pass in the host header for local TdfDev execution. </summary> </member> <member name="F:MicrosoftPlaces.Constants.UserAgentHeaderValue"> <summary> The const value for the user agent. </summary> </member> <member name="F:MicrosoftPlaces.Constants.DisableABPFilteringForAdminHeaderName"> <summary> Header to disable ABP filtering on read path if caller has Place Admin role (TenantPlacesManagement). </summary> </member> <member name="F:MicrosoftPlaces.Constants.TorusUserSuffix"> <summary> Torus related constants. </summary> </member> <member name="F:MicrosoftPlaces.Constants.NoConnected"> <summary> Messages shown as result or exceptions in Cmdlets. </summary> </member> <member name="F:MicrosoftPlaces.Constants.QueryBingWarning"> <summary> Warning shown when user pass queryBing parameter. </summary> </member> <member name="P:MicrosoftPlaces.ConnectPsCmdlet.Environment"> <summary> Environment parameter is used to load app settings based on the environment where the command is being runned from. Mostly used for Dev / local test to load TDF settings instead of prod. </summary> </member> <member name="P:MicrosoftPlaces.ConnectPsCmdlet.AccessToken"> <summary> Parameter to add a custom access token to the session. Just valid on TDS, ignored for all other environments. </summary> </member> <member name="P:MicrosoftPlaces.ConnectPsCmdlet.SmtpAddress"> <summary> Parameter to add a custom smtp address to the session. Just valid on TDS, ignored for all other environments. </summary> </member> <member name="P:MicrosoftPlaces.ConnectPsCmdlet.TenantId"> <summary> Parameter to add a custom tenant id to the session. Just valid on TDS, ignored for all other environments. </summary> </member> <member name="M:MicrosoftPlaces.ConnectPsCmdlet.InitializeServiceParameters"> <summary> Init common cmdlet configuration and initialize CdmletSession instance. </summary> </member> <member name="P:MicrosoftPlaces.PlacesAnalyticsPSCmdlet.UseLocalHost"> <summary> Used for debugging purposes. If set, the cmdlet will use localhost instead of the production service. </summary> </member> <member name="M:MicrosoftPlaces.PlacesAnalyticsPSCmdlet.HandleLocalHostRequest(System.Net.Http.HttpRequestMessage)"> <summary> Adds an authorization header to the request that will work with our TDF tenant. </summary> <param name="request"></param> </member> <member name="P:MicrosoftPlaces.PlacesAnalytics.GetDataset.Type"> <summary> The dataset from which to download data. </summary> </member> <member name="P:MicrosoftPlaces.PlacesAnalytics.GetDataset.PushDate"> <summary> The date on which the requested data was previously pushed. Should be in YYYY-MM-dd format, e.g. "2023-07-29". </summary> </member> <member name="P:MicrosoftPlaces.PlacesAnalytics.GetDataset.OutputDirectory"> <summary> The directory to which to write the downloaded csv file. </summary> </member> <member name="P:MicrosoftPlaces.PlacesAnalytics.GetDataset.Filename"> <summary> The name of the file to download. </summary> </member> <member name="P:MicrosoftPlaces.PlacesAnalytics.GetDatasetStatus.Type"> <summary> The dataset from which to download data. </summary> </member> <member name="P:MicrosoftPlaces.PlacesAnalytics.GetDatasetStatus.PushDate"> <summary> The date on which the requested data was previously pushed. Should be in YYYY-MM-dd format, e.g. "2023-07-29". </summary> </member> <member name="T:MicrosoftPlaces.PlacesAnalytics.PushDataset"> <summary> Cmdlet used to batch-upload telemetry data to PAS. Sample usage: <c>Push-Dataset -Type RoomOccupancy -Path C:\sensordata\ -DeviceType Standard</c>. </summary> </member> <member name="M:MicrosoftPlaces.PlacesAnalytics.SubmitPlacesAnalyticsData.CallLocalHost(System.Byte[])"> <summary> Calls PlacesAnalytics service running on local host for testing. Content will be uploaded to ADLS under this.MockTid name in PlacesPartners container. </summary> <param name="fileContent">Zip file including data and metadata, in byte array.</param> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.HttpClient"> <summary> The HTTP client </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.Url"> <summary> The URL </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.JsonContentType"> <summary> The json content type </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.AuthScheme"> <summary> The authentication scheme </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.MockToken"> <summary> The mock token for development. </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.ClientRequestIdHeader"> <summary> The client request identifier header </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.UnknownErrorMessage"> <summary> The unknown error message </summary> </member> <member name="P:MicrosoftPlaces.PlacesDevicesPSCmdlet.IsDev"> <summary> Dev switch to enable local dev execution. Mostly used for Visual Studio launching. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.GetResourceUri"> <summary> Get the uri based on the environment </summary> <returns></returns> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.GetDeviceApiHeaders"> <summary> Gets the device API headers. </summary> <returns>The headers.</returns> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.GetHttpRequestMessage(System.Net.Http.HttpMethod,System.Uri,System.String)"> <summary> Gets the HTTP request message. </summary> <returns>The http request message.</returns> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.SendHttpRequest(System.Net.Http.HttpRequestMessage,System.Action{System.Net.Http.HttpResponseMessage},System.Action{System.Net.Http.HttpResponseMessage})"> <summary> Handles the request. </summary> <param name="httpRequestMessage">The HTTP request message.</param> <param name="successAction">The success action.</param> <param name="errorAction">The error action.</param> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.ProcessRecord"> <summary> Processes the record. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.GetIdUri(System.String)"> <summary> Gets the identifier URI. </summary> <param name="id">The identifier.</param> <returns>The identifier URI.</returns> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.GetErrorRecord(System.Net.Http.HttpResponseMessage)"> <summary> Gets the error record. </summary> <param name="response">The response.</param> <returns>The error record.></returns> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.DeviceId"> <summary> Gets or sets the user provided device identifier. </summary> <value> The device identifier of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.DisplayName"> <summary> Gets or sets the display name of the device. </summary> <value> The display name of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.Description"> <summary> Gets or sets the description of the device. </summary> <value> The description of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.MACAddress"> <summary> Gets or sets the mac address of the device. </summary> <value> The mac address of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.Manufacturer"> <summary> Gets or sets the manufacturer. </summary> <value> The manufacturer of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.IPV4Address"> <summary> Gets or sets the ip v4 address. </summary> <value> The ip v4 address of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.IPV6Address"> <summary> Gets or sets the ip v6 address of the device. </summary> <value> The ip v6 address of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.PlaceId"> <summary> Gets or sets the place identifier of the device. </summary> <value> The place identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.Tags"> <summary> Gets or sets the tags of the device. </summary> <value> The tags of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.Sensors"> <summary> Gets or sets the sensors of the device. </summary> <value> The sensors of the device. </value> </member> <member name="M:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.ExecuteCmdlet"> <summary> Executes the cmdlet by creating a new device object. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDevices.DeletePlaceDevice.Id"> <summary> Gets or sets the identifier. </summary> <value> The identifier. </value> </member> <member name="M:MicrosoftPlaces.PlacesDevices.DeletePlaceDevice.ExecuteCmdlet"> <summary> Executes the cmdlet to delete a device. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDevices.GetPlaceDevice.Id"> <summary> Gets or sets the identifier. </summary> <value> The identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.GetPlaceDevice.Filter"> <summary> Gets or sets the query filter. If left blank will fetch top 10 overall results. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDevices.GetPlaceDevice.Top"> <summary> Gets or sets the top number of results received. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDevices.GetPlaceDevice.ExecuteCmdlet"> <summary> Executes the cmdlet. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDevices.GetPlaceDevice.GetDeviceById"> <summary> Retrieves a device by its ID. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDevices.GetPlaceDevice.ListDevices"> <summary> Lists devices based on specified parameters. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDevices.GetPlaceDevice.GetListUri"> <summary> Constructs the URI for listing devices based on specified parameters. </summary> </member> <member name="T:MicrosoftPlaces.PlacesDevices.Device"> <summary> Device data model. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.Id"> <summary> Gets or sets the identifier. </summary> <value> The identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.DeviceId"> <summary> Gets or sets the device identifier. </summary> <value> The device identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.DisplayName"> <summary> Gets or sets the display name. </summary> <value> The display name. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.Description"> <summary> Gets or sets the description. </summary> <value> The description. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.MACAddress"> <summary> Gets or sets the mac address. </summary> <value> The mac address. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.Manufacturer"> <summary> Gets or sets the manufacturer. </summary> <value> The manufacturer. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.IPV4Address"> <summary> Gets or sets the ip v4 address. </summary> <value> The ip v4 address. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.IPV6Address"> <summary> Gets or sets the ip v6 address. </summary> <value> The ip v6 address. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.PlaceId"> <summary> Gets or sets the place identifier. </summary> <value> The place identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.Tags"> <summary> Gets or sets the tags. </summary> <value> The tags. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.Sensors"> <summary> Gets or sets the sensors. </summary> <value> The sensors. </value> </member> <member name="T:MicrosoftPlaces.PlacesDevices.Sensor"> <summary> Sensor data model. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Sensor.SensorId"> <summary> Gets or sets the sensor identifier. </summary> <value> The sensor identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Sensor.DisplayName"> <summary> Gets or sets the display name. </summary> <value> The display name. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Sensor.SensorType"> <summary> Gets or sets the type of the sensor. </summary> <value> The type of the sensor. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Sensor.PlaceId"> <summary> Gets or sets the place identifier. </summary> <value> The place identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.Id"> <summary> Gets or sets the identifier. </summary> <value> The identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.DeviceId"> <summary> Gets or sets the user provided device identifier. </summary> <value> The device identifier of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.DisplayName"> <summary> Gets or sets the display name of the device. </summary> <value> The display name of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.Description"> <summary> Gets or sets the description of the device. </summary> <value> The description of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.MACAddress"> <summary> Gets or sets the mac address of the device. </summary> <value> The mac address of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.Manufacturer"> <summary> Gets or sets the manufacturer. </summary> <value> The manufacturer of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.IPV4Address"> <summary> Gets or sets the ip v4 address. </summary> <value> The ip v4 address of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.IPV6Address"> <summary> Gets or sets the ip v6 address of the device. </summary> <value> The ip v6 address of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.PlaceId"> <summary> Gets or sets the place identifier of the device. </summary> <value> The place identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.Tags"> <summary> Gets or sets the tags of the device. </summary> <value> The tags of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.Sensors"> <summary> Gets or sets the sensors of the device. </summary> <value> The sensors of the device. </value> </member> <member name="M:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.ExecuteCmdlet"> <summary> Update the deviceSensor metadata. Parses the data and use deviceInventoryService API to update the deviceSensor metadata. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.PostalCode"> <summary> Zipcode. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.CountryOrRegion"> <summary> CountryOrRegion. CountryOrRegion must be a valid ISO code. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.State"> <summary> State. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.City"> <summary> City name. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.Street"> <summary> Street address. </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.MaxLatitude"> <summary>Maximum valid latitude</summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.MinLatitude"> <summary>Minimum valid latitude</summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.MaxLongitude"> <summary>Maximum valid longitude</summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.MinLongitude"> <summary>Minimum valid longitude</summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:MicrosoftPlaces.PlacesDirectory.GeoCoordinates"/> class. </summary> <param name="expression">The string representation of the GeoCoordinates</param> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.#ctor(System.Double,System.Double)"> <summary> Initializes a new instance of the <see cref="T:MicrosoftPlaces.PlacesDirectory.GeoCoordinates"/> class. </summary> <param name="latitude">Latitude (in degrees)</param> <param name="longitude">Longitude (in degrees)</param> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.#ctor(System.Double,System.Double,System.Double)"> <summary> Initializes a new instance of the <see cref="T:MicrosoftPlaces.PlacesDirectory.GeoCoordinates"/> class. </summary> <param name="latitude">Latitude (in degrees)</param> <param name="longitude">Longitude (in degrees)</param> <param name="altitude">Altitude (in meters)</param> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.Latitude"> <summary> Latitude (in degrees) </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.Longitude"> <summary> Longitude (in degrees) </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.Altitude"> <summary> Altitude (in meters) </summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.ToString"> <summary> Displays the string representation of the <see cref="T:MicrosoftPlaces.PlacesDirectory.GeoCoordinates"/> </summary> <returns>The string representation of the <see cref="T:MicrosoftPlaces.PlacesDirectory.GeoCoordinates"/></returns> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.IsValidLatitude(System.Double)"> <summary> Verifies if the specified value is a valid latitude </summary> <param name="latitude">The value to be verified</param> <returns>True if the value is a valid latitude, otherwise false</returns> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.IsValidLongitude(System.Double)"> <summary> Verifies if the specified value is a valid longitude </summary> <param name="longitude">The value to be verified</param> <returns>True if the value is a valid longitude, otherwise false</returns> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.ParseAndValidateGeoCoordinates(System.String)"> <summary> Parse and validate the specified string into <see cref="T:MicrosoftPlaces.PlacesDirectory.GeoCoordinates"/> </summary> <param name="geoCoordinates">The geocoordinates in string format</param> </member> <member name="T:MicrosoftPlaces.PlacesDirectory.InitializePlaces"> <summary> Cmdlet who has the capacity to onboard locations to Places App. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.InitializePlaces.OnboardLocations"> <summary> This step read the csv content and creates/updates places. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.InitializePlaces.OnboardBuildings(System.Collections.Generic.List{MicrosoftPlaces.PlacesDirectory.BootstrapImportProcess},System.Management.Automation.ProgressRecord)"> <summary> Process the Buildings in the imported CSV. Creates the one that have not being created yet. </summary> <param name="places"></param> <param name="progressRecord"></param> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.InitializePlaces.OnboardFloors(System.Collections.Generic.List{MicrosoftPlaces.PlacesDirectory.BootstrapImportProcess},System.Management.Automation.ProgressRecord)"> <summary> Process the Floors in the imported CSV. Creates the one that have not being created yet. </summary> <param name="places"></param> <param name="progressRecord"></param> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.InitializePlaces.OnboardRoomsAndSpaces(System.Collections.Generic.List{MicrosoftPlaces.PlacesDirectory.BootstrapImportProcess},System.Management.Automation.ProgressRecord)"> <summary> Process Rooms and Workspaces in the imported CSV. Updates them with location hierarchy when needed. </summary> <param name="places"></param> <param name="progressRecord"></param> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.InitializePlaces.GenerateOnboardingScript"> <summary> This step read the csv content and creates a PowerShell script with the onboarding instructions to execute. </summary> </member> <member name="T:MicrosoftPlaces.PlacesDirectory.NewPlaceType"> <summary> In this Enum we define the valid type of places that are valid to create from the New-Place cmdlet. </summary> </member> <member name="T:MicrosoftPlaces.PlacesDirectory.BookingType"> <summary> Booking Type enum </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.BookingType.Unknown"> <summary> Unknown booking type </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.BookingType.Standard"> <summary> Standard booking type. In the context of conference rooms this means auto-accept if available </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.BookingType.Reserved"> <summary> Reserved booking type. In the context of conference rooms this means that the room can't be booked </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.PlaceId"> <summary> The Guid identity of the place. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.DisplayName"> <summary> Name of the place. For backcompatibility with EXO v1 we name it as DisplayName. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Type"> <summary> Type of the place. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Identity"> <summary> The smtp address (for places created over a mailbox) or the Name_Guid combination for non mailboxes places. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Label"> <summary> Description of the place. For backcompatibility with EXO v1 we name it as Label. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.PostalCode"> <summary> Zipcode. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.CountryOrRegion"> <summary> CountryOrRegion. CountryOrRegion must be a valid ISO code. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.State"> <summary> State. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.City"> <summary> City name. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Street"> <summary> Street address. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.ParentId"> <summary> id of the parent place that the place belongs to. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.TryParseAsV3PlaceIdentity(System.String,System.String@)"> <summary> We distinguish V1 and V3 places on the type of Identity. V3 places have a Guid as identifier. V1 places have SMTP address or alias. We also support Name_GUID format for V3, which is retrieved as Identity in Presentation Object. </summary> <returns></returns> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.TryParseAsV3PlaceNameGuidIdentity(System.String,System.String@)"> <summary> Identify is Identity provided as parameter is in the format Name_GUID for V3Places We return true if it matches the format and identity is updated to contain the GUID portion of it so it can be passed to the service. </summary> <param name="identity"></param> <returns></returns> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.Unlimited`1.#ctor(`0)"> <summary> Constructor for limited number scenario. </summary> <param name="limitedValue"></param> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.Unlimited`1.#ctor(System.String)"> <summary> Constructor for unlimited scenario. </summary> <param name="expression"></param> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.Unlimited`1.Value"> <summary> Return Value inside </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.Unlimited`1.IsUnlimited"> <summary> Return whether the instance is unlimited value </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.PostalCode"> <summary> Zipcode. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.CountryOrRegion"> <summary> CountryOrRegion. CountryOrRegion must be a valid ISO code. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.State"> <summary> State. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.City"> <summary> City name. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.Street"> <summary> Street address. </summary> </member> <member name="F:MicrosoftPlaces.PlacesMaps.ImportMapCorrelations.FeaturesToExport"> <summary> Map feature types that can be correlatable to objects in Places Directory. </summary> </member> <member name="F:MicrosoftPlaces.PlacesMaps.ImportMapCorrelations.CategoriesToExclude"> <summary> Known feature categories that won't be correlated to anything in Directory and should be ignored when creating a list of features to correlate. </summary> </member> <member name="T:MicrosoftPlaces.PlacesSeatAssignments.GetSeatAssignment"> <summary> Cmdlet used to list seat assignments in a place. Sample usage: <c>Get-SeatAssignment -UserId UserId</c>. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSeatAssignments.GetSeatAssignment.UserId"> <summary> User Id parameter. </summary> </member> <member name="T:MicrosoftPlaces.PlacesSeatAssignments.GetSeatAssignmentsByPlace"> <summary> Cmdlet used to list seat assignments in a place. Sample usage: <c>Get-SeatAssignmentsByPlace -PlaceId placeId</c>. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSeatAssignments.GetSeatAssignmentsByPlace.PlaceId"> <summary> Place Id parameter. </summary> </member> <member name="T:MicrosoftPlaces.PlacesSeatAssignments.RemoveSeatAssignment"> <summary> Cmdlet used to delete a seat assignment. Sample usage: <c>Remove-SeatAssignment -UserId userId</c>. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSeatAssignments.RemoveSeatAssignment.UserId"> <summary> User Id parameter. </summary> </member> <member name="T:MicrosoftPlaces.PlacesSeatAssignments.SetSeatAssignments"> <summary> Cmdlet used to set a seat assignment. Sample usage: <c>Set-SeatAssignments -UserId userId -PlaceId placeId</c>. <c>Set-SeatAssignments -Csv pathToCsv</c>. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSeatAssignments.SetSeatAssignments.UserId"> <summary> User Id parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSeatAssignments.SetSeatAssignments.PlaceId"> <summary> Place Id parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSeatAssignments.SetSeatAssignments.Csv"> <summary> Csv path parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSeatAssignments.SetSeatAssignments.InsertOnly"> <summary> InsertOnly flag. Set if purpose is to only create a new assignment, but not updating existing ones. If this value is not set, the value is false and existing assignments are updated. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettingsPSCmdlet.IsDev"> <summary> Dev switch to enable local dev execution. Mostly used for Visual Studio launching. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.GetPlacesSettings.Collection"> <summary> Gets or sets a value indicating which collection to get the settings from. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.GetPlacesSettings.ReadFromPrimary"> <summary> If enabled, get the settings data from primary source instead of from cache. </summary> </member> <member name="M:MicrosoftPlaces.PlacesSettings.GetPlacesSettings.ExecuteCmdlet"> <summary> Gets all the settings for the tenant. </summary> </member> <member name="F:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.properties"> <summary> This dictionary field contains all the valid parameters for properties that can be set on the Places settings. These parameters are specified in the properties below, which are taken from the command line by their names defined on Constants.cs. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.Collection"> <summary> Gets or sets a value indicating which collection to set the settings from. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.Entitlement"> <summary> Entitlement parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.WorkplaceWifiNetworkSSIDList"> <summary> WorkplaceWifiNetworkSSIDList parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.AllowInConnectionsList"> <summary> AllowInConnectionsList parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.PlacesEnabled"> <summary> PlacesEnabled parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.SpaceAnalyticsEnabled"> <summary> SpaceAnalyticsEnabled parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.SpaceAnalyticsBuildingsList"> <summary> SpaceAnalyticsBuildingsList parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.PeopleDirectoryLocationFormat"> <summary> PeopleDirectoryLocationFormat parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.EnableBuildings"> <summary> EnableBuildings parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.PlacesFinderEnabled"> <summary> PlacesFinderEnabled parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.EnablePlacesMobileApp"> <summary> EnablePlacesMobileApp parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.EnablePlacesWebApp"> <summary> EnablePlacesWebApp parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.EnableHybridGuidance"> <summary> EnableWorkGroups parameter. </summary> </member> <member name="M:MicrosoftPlaces.PlacesSettings.SettingsConverters.ValidateSettingsPrefix(System.String)"> <summary> Validate and return the same settings prefix if it is valid. </summary> <param name="settingsPrefix">The settings prefix to validate.</param> <returns>The prefix, if it is valid.</returns> <exception cref="T:System.ArgumentException">If the settings prefix is not valid.</exception> </member> <member name="M:MicrosoftPlaces.PlacesSettings.SettingsConverters.ValidateProperties(System.Collections.Generic.IDictionary{System.String,System.String},System.String)"> <summary> Validate and convert the parameters passed to a Update cmdlet. </summary> <param name="parameters">The values passed as a dictionary, with the parameter name as key and scoped values as value in string format.</param> <param name="settingsPrefix">The settings namespace to validate and convert the values.</param> <returns>A dictionary with the parameter full name as key and scoped values as value.</returns> <exception cref="T:System.ArgumentException">If there are no parameters or one of the keys or values is invalid.</exception> </member> <member name="M:MicrosoftPlaces.PlacesSettings.SettingsConverters.ParseToScopedValues(System.String,System.String)"> <summary> Receives a scoped value in string format and convert it to a ScopedValue object. </summary> <param name="scopedId">A valid scope id.</param> <param name="scopedValues">A scope value in string format.</param> <returns>A ScopedValue object.</returns> <exception cref="T:System.ArgumentException">If the value is invalid, due to have an invalid format or an invalid scopeId.</exception> </member> <member name="M:MicrosoftPlaces.PlacesSettings.SettingsConverters.ValidateScopeId(System.String)"> <summary> Receives a scopeId in string format and validate it. </summary> <param name="scopeId">A scopeId in string format.</param> <returns>The same scopeId passed.</returns> <exception cref="T:System.ArgumentException">If the scopeId is not "Default" and not in the format "OID:[OID]@[TID]".</exception> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SettingsPresentationObject.Name"> <summary> The Name of the setting. </summary> </member> </members> </doc> |