MicrosoftPlaces.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>MicrosoftPlaces</name> </assembly> <members> <member name="P:MicrosoftPlaces.BasePSCmdlet.IsDev"> <summary> Dev switch to enable local dev execution. Mostly used for Visual Studio launching. </summary> </member> <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.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="P:MicrosoftPlaces.BuildingPresentationObject.Identity"> <summary> The id. </summary> </member> <member name="P:MicrosoftPlaces.BuildingPresentationObject.Name"> <summary> Name of the building. </summary> </member> <member name="P:MicrosoftPlaces.BuildingPresentationObject.PostOfficeBox"> <summary> Post office box info. </summary> </member> <member name="P:MicrosoftPlaces.BuildingPresentationObject.PostalCode"> <summary> Zipcode. </summary> </member> <member name="P:MicrosoftPlaces.BuildingPresentationObject.CountryCode"> <summary> CountryCode. CountryCode must be a valid ISO code. </summary> </member> <member name="P:MicrosoftPlaces.BuildingPresentationObject.State"> <summary> State. </summary> </member> <member name="P:MicrosoftPlaces.BuildingPresentationObject.City"> <summary> City name. </summary> </member> <member name="P:MicrosoftPlaces.BuildingPresentationObject.Street"> <summary> Street address. </summary> </member> <member name="P:MicrosoftPlaces.BuildingPresentationObject.CampusId"> <summary> id of the campus that the building is in. </summary> </member> <member name="P:MicrosoftPlaces.BuildingPresentationObject.AddressType"> <summary> AddressType. Currently supported types: Home, Business, Other. </summary> </member> <member name="M:MicrosoftPlaces.AdalAccessToken.GetAccessToken"> <summary> Get Access Token asynchronously using MSAL auth Get Access Token for various scenarios 1. Context.CredentialUserName and Context.CredentialPassword is present : Then a new token is created based on the values. -No UI based browser redirect 2. If its device auth get the code and print it out and then wait for user to enter it in browser 3. Context.CredentialUserName is present and Context.CredentialPassword is null. It then lands the user automatically to a browser. 4. Context.UserPrincipalName is present : It takes it up as hint and lands him to browser with that UPN populated. 5. Context.UserPrincipalName is null : It takes it up as hint and lands him to browser asking for selecting a account or entering UPN. </summary> <returns>Returns AccessToken</returns> </member> <member name="M:MicrosoftPlaces.AdalAccessToken.Dispose"> <summary> Dispose method - removes the delegate. </summary> </member> <member name="M:MicrosoftPlaces.AdalAccessToken.InvokeCancellation"> <summary> Method to invoke cancellation of token acquisition </summary> </member> <member name="M:MicrosoftPlaces.ArgumentValidator.ThrowIfNull(System.String,System.Object)"> <summary> Helper to throw if the argument is null. </summary> <param name="name">Name of the argument.</param> <param name="arg">Argument to test.</param> </member> <member name="M:MicrosoftPlaces.ArgumentValidator.ThrowIfNullOrEmpty(System.String,System.String)"> <summary> Helper to throw if the argument is empty. </summary> <param name="name">Name of the argument.</param> <param name="arg">Argument to test.</param> </member> <member name="T:MicrosoftPlaces.AuthType"> <summary> Auth types </summary> </member> <member name="F:MicrosoftPlaces.AuthType.Default"> <summary> Log in using default auth i.e. MSI auth for .netstandard 2.0 and normal auth otherwise </summary> </member> <member name="F:MicrosoftPlaces.AuthType.Device"> <summary> Log in using device auth Valid only for Cloud Shell .netstandard 2.0 </summary> </member> <member name="T:MicrosoftPlaces.CachedCmdletSession"> <summary> Json serialization class for Session cache data </summary> </member> <member name="F:MicrosoftPlaces.CachedCmdletSession.TokenSpanInHours"> <summary> The token lifespan in hours. </summary> </member> <member name="P:MicrosoftPlaces.CachedCmdletSession.Token"> <summary> Gets or sets the token. </summary> </member> <member name="P:MicrosoftPlaces.CachedCmdletSession.UserSmtpAddress"> <summary> Gets or sets the user SMTP address. </summary> </member> <member name="P:MicrosoftPlaces.CachedCmdletSession.TenantId"> <summary> Gets or sets the tenantId from the authenticated user. </summary> </member> <member name="P:MicrosoftPlaces.CachedCmdletSession.Timestamp"> <summary> Gets or sets the timestamp. </summary> </member> <member name="P:MicrosoftPlaces.CachedCmdletSession.IsTorusCommand"> <summary> Gets or sets the token. </summary> </member> <member name="P:MicrosoftPlaces.CachedCmdletSession.IsActive"> <summary> Gets a value indicating whether this <see cref="T:MicrosoftPlaces.CachedCmdletSession"/> is still valid. </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="M:MicrosoftPlaces.CmdletSession.GetSessionToken(System.Boolean)"> <summary> Returns an authentication token. First it will try to read if from cache file, if valid. If not it will generate a new one and store it in cache file. </summary> <param name="fromCache">if true, only tried to read token from cache. If no valid token is present it will return null.</param> <returns></returns> </member> <member name="M:MicrosoftPlaces.CmdletSession.LoadCmdletSessionFromCacheFile"> <summary> Reads the session from cache file, if any, and instanciate SmtpAddress and EnvironmentConfiguration values that are needed for later execution. </summary> <exception cref="T:System.InvalidOperationException"></exception> </member> <member name="M:MicrosoftPlaces.CmdletSession.SessionIsValid(MicrosoftPlaces.CachedCmdletSession)"> <summary> Validate session token from cache. </summary> <param name="session">The token.</param> <returns>True if token is valid; otherwise false.</returns> </member> <member name="M:MicrosoftPlaces.CmdletSession.SessionIsValid(System.String,MicrosoftPlaces.CachedCmdletSession)"> <summary> Validate session token from cache. </summary> <param name="userSmtpAddress">The user SMTP address.</param> <param name="session">The token.</param> <returns>True if token is valid; otherwise false.</returns> </member> <member name="M:MicrosoftPlaces.CmdletSession.SaveTokenToFile(MicrosoftPlaces.CachedCmdletSession,System.String)"> <summary> Saves the session current data to file. </summary> <param name="session">The session data.</param> <param name="filePath">The cached token file path.</param> </member> <member name="M:MicrosoftPlaces.CmdletSession.LoadCachedToken(System.String)"> <summary> Loads cached session data. </summary> <param name="filePath">The cached session file path.</param> <returns>Cached token instance.</returns> </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.UserAgentHeaderValue"> <summary> The const value for the user agent. </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="T:MicrosoftPlaces.EnvironmentConfiguration"> <summary> This class stores the cmdlet settings for various services for a single environment. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.DefaultEnvironmentType"> <summary> Default environment type if you don't specify environment. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.EnvironmentType"> <summary> Environment type (PROD, INT, DOD, GCCH, Gallatin etc). </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.ResourceId"> <summary> ResourceId. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.AADAuthority"> <summary> AAD Authority. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.ClientId"> <summary> ClientId. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.RedirectUri"> <summary> RedirectUri. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.Host"> <summary> Environment host. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.AdminApiHost"> <summary> Environment adminApi host. </summary> </member> <member name="P:MicrosoftPlaces.ConnectPsCmdlet.SmtpAddress"> <summary> User Smtp Address used for token authentication. </summary> </member> <member name="P:MicrosoftPlaces.ConnectPsCmdlet.Password"> <summary> Password credential for getting token using User+Password. </summary> </member> <member name="P:MicrosoftPlaces.ConnectPsCmdlet.Device"> <summary> Switch to using Device auth for token retrieval. </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="M:MicrosoftPlaces.ConnectPsCmdlet.InitializeServiceParameters"> <summary> Init common cmdlet configuration and initialize CdmletSession instance. </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="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.GetResourceUri"> <summary> Get the uri based on the environment </summary> <returns></returns> </member> <member name="M:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.ExecuteCmdlet"> <summary> Cmdlet to create deviceSensor metadata Accepts a CSV file, parses it and creates the deviceSensor metadata </summary> </member> <member name="M:MicrosoftPlaces.PlacesDevices.DeletePlaceDevice.ExecuteCmdlet"> <summary> Parses the CSV file and gets the deviceIds Calls the delete API for deviceIds </summary> </member> <member name="T:MicrosoftPlaces.PlacesDevices.Device"> <summary> Device data model. Used for mapping the data from csv. </summary> </member> <member name="T:MicrosoftPlaces.PlacesDevices.Sensor"> <summary> Sensor data model. Used for mapping the data from csv. </summary> </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.PostOfficeBox"> <summary> Post office box info. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.PostalCode"> <summary> Zipcode. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.CountryCode"> <summary> CountryCode. CountryCode 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="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.AddressType"> <summary> Type. </summary> </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.ExportLocationHierarchy"> <summary> This step get the existing locations and exports it to a csv file. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.InitializePlaces.OnboardLocations"> <summary> This step read the csv content and creates/updates places. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Identity"> <summary> The id. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Name"> <summary> Name of the place. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Type"> <summary> Type of the place. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Description"> <summary> Description of the place. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.PostOfficeBox"> <summary> Post office box info. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.PostalCode"> <summary> Zipcode. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.CountryCode"> <summary> CountryCode. CountryCode 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="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.ParentName"> <summary> id of the parent place that the place belongs to. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.AddressType"> <summary> AddressType. Currently supported types: Home, Business, Other. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.SortOrder"> <summary> Sort Order. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.PostOfficeBox"> <summary> Post office box info. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.PostalCode"> <summary> Zipcode. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.CountryCode"> <summary> CountryCode. CountryCode 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="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.AddressType"> <summary> Type. </summary> </member> <member name="T:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1"> <summary> The type of place in v1. </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1.Unknown"> <summary> Unknown place type </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1.Room"> <summary> Place type for conference rooms </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1.RoomList"> <summary> Place type for room lists </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1.Place"> <summary> Place type for a place such as an address or a business. </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1.Space"> <summary> Place type for Spaces </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1.Desk"> <summary> Place type for Desks </summary> </member> <member name="T:MicrosoftPlaces.PlacesDirectory.ParentLocationType"> <summary> Enum to determine what is the parent type for a resource. </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.ParentLocationType.None"> <summary> Not specified </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.ParentLocationType.Section"> <summary> Section is the parent </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.ParentLocationType.Floor"> <summary> Floor is the parent </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Identity"> <summary> The email address. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.DisplayName"> <summary> Place Display Name. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Type"> <summary> Place Type. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Street"> <summary> Street of Place Address </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.City"> <summary> City of Place Address </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.State"> <summary> State of Place address </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.PostalCode"> <summary> Postal Code. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.GeoCoordinates"> <summary> The GeoCoordinates. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Capacity"> <summary> The Capacity </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Building"> <summary> The building </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.ParentType"> <summary> The type of this Location's Parent </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.CampusId"> <summary> ID of the Campus node in the Location Hierarchy </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.BuildingId"> <summary> ID of the Building node in the Location Hierarchy </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.FloorId"> <summary> ID of the Floor node in the Location Hierarchy </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.SectionId"> <summary> ID of the Section node in the Location Hierarchy </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Label"> <summary> The place label </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.MTREnabled"> <summary> MTREnabled </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.AudioDeviceName"> <summary> The AudioDeviceName </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.VideoDeviceName"> <summary> The VideoDeviceName </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.DisplayDeviceName"> <summary> The DisplayDeviceName </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Floor"> <summary> The Floor </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.FloorLabel"> <summary> The floor label </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Localities"> <summary> Place Capabilities </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.RoomListNames"> <summary> Place Capabilities </summary> </member> </members> </doc> |