Skip to content

Microsoft.JSInterop - Undoc 6.0 APIs #7286

@carlossanlop

Description

@carlossanlop

The APIs in the table below were introduced in .NET 6.0 and are showing up as undocumented in the dotnet-api-docs repo.

Some of them are already documented in triple slash comments in source. Area owners, please:

  1. Verify if there are any APIs from the table have not been documented in source. If you find any, document them in triple slash and submit a PR to runtime to commit the documentation.
  2. Clone the dotnet-api-docs repo and port the triple slash comments by running this DocsPortingTool command:
DocsPortingTool \
    -Direction ToDocs \
    -Docs %REPOS%\dotnet-api-docs\xml \
    -Intellisense %REPOS%\runtime\artifacts\bin\ \
    -IncludedAssemblies Microsoft.JSInterop \
    -IncludedNamespaces Microsoft.JSInterop \
    -Save true
  1. Submit a PR to dotnet-api-docs with the ported documentation.
Undoc 6.0 Microsoft.JSInterop APIs table
Undoc 6.0 API
N:Microsoft.JSInterop
M:Microsoft.JSInterop.DotNetObjectReference.Create``1(``0)
T:Microsoft.JSInterop.DotNetObjectReference
M:Microsoft.JSInterop.DotNetObjectReference`1.Dispose
T:Microsoft.JSInterop.DotNetObjectReference`1
P:Microsoft.JSInterop.DotNetObjectReference`1.Value
T:Microsoft.JSInterop.IJSInProcessObjectReference
M:Microsoft.JSInterop.IJSInProcessObjectReference.Invoke``1(System.String,System.Object[])
T:Microsoft.JSInterop.IJSInProcessRuntime
M:Microsoft.JSInterop.IJSInProcessRuntime.Invoke``1(System.String,System.Object[])
T:Microsoft.JSInterop.IJSObjectReference
M:Microsoft.JSInterop.IJSObjectReference.InvokeAsync``1(System.String,System.Object[])
M:Microsoft.JSInterop.IJSObjectReference.InvokeAsync``1(System.String,System.Threading.CancellationToken,System.Object[])
T:Microsoft.JSInterop.IJSRuntime
M:Microsoft.JSInterop.IJSRuntime.InvokeAsync``1(System.String,System.Threading.CancellationToken,System.Object[])
M:Microsoft.JSInterop.IJSRuntime.InvokeAsync``1(System.String,System.Object[])
T:Microsoft.JSInterop.IJSUnmarshalledObjectReference
M:Microsoft.JSInterop.IJSUnmarshalledObjectReference.InvokeUnmarshalled``4(System.String,``0,``1,``2)
M:Microsoft.JSInterop.IJSUnmarshalledObjectReference.InvokeUnmarshalled``3(System.String,``0,``1)
M:Microsoft.JSInterop.IJSUnmarshalledObjectReference.InvokeUnmarshalled``2(System.String,``0)
M:Microsoft.JSInterop.IJSUnmarshalledObjectReference.InvokeUnmarshalled``1(System.String)
T:Microsoft.JSInterop.IJSUnmarshalledRuntime
M:Microsoft.JSInterop.IJSUnmarshalledRuntime.InvokeUnmarshalled``4(System.String,``0,``1,``2)
M:Microsoft.JSInterop.IJSUnmarshalledRuntime.InvokeUnmarshalled``3(System.String,``0,``1)
M:Microsoft.JSInterop.IJSUnmarshalledRuntime.InvokeUnmarshalled``2(System.String,``0)
M:Microsoft.JSInterop.IJSUnmarshalledRuntime.InvokeUnmarshalled``1(System.String)
F:Microsoft.JSInterop.JSCallResultType.Default
T:Microsoft.JSInterop.JSCallResultType
F:Microsoft.JSInterop.JSCallResultType.JSObjectReference
M:Microsoft.JSInterop.JSException.#ctor(System.String)
M:Microsoft.JSInterop.JSException.#ctor(System.String,System.Exception)
T:Microsoft.JSInterop.JSException
M:Microsoft.JSInterop.JSInProcessObjectReferenceExtensions.InvokeVoid(Microsoft.JSInterop.IJSInProcessObjectReference,System.String,System.Object[])
T:Microsoft.JSInterop.JSInProcessObjectReferenceExtensions
M:Microsoft.JSInterop.JSInProcessRuntime.#ctor
M:Microsoft.JSInterop.JSInProcessRuntime.Invoke``1(System.String,System.Object[])
M:Microsoft.JSInterop.JSInProcessRuntime.InvokeJS(System.String,System.String,Microsoft.JSInterop.JSCallResultType,System.Int64)
M:Microsoft.JSInterop.JSInProcessRuntime.InvokeJS(System.String,System.String)
T:Microsoft.JSInterop.JSInProcessRuntime
M:Microsoft.JSInterop.JSInProcessRuntimeExtensions.InvokeVoid(Microsoft.JSInterop.IJSInProcessRuntime,System.String,System.Object[])
T:Microsoft.JSInterop.JSInProcessRuntimeExtensions
M:Microsoft.JSInterop.JSInvokableAttribute.#ctor(System.String)
M:Microsoft.JSInterop.JSInvokableAttribute.#ctor
P:Microsoft.JSInterop.JSInvokableAttribute.Identifier
T:Microsoft.JSInterop.JSInvokableAttribute
M:Microsoft.JSInterop.JSObjectReferenceExtensions.InvokeAsync``1(Microsoft.JSInterop.IJSObjectReference,System.String,System.TimeSpan,System.Object[])
M:Microsoft.JSInterop.JSObjectReferenceExtensions.InvokeAsync``1(Microsoft.JSInterop.IJSObjectReference,System.String,System.Threading.CancellationToken,System.Object[])
M:Microsoft.JSInterop.JSObjectReferenceExtensions.InvokeAsync``1(Microsoft.JSInterop.IJSObjectReference,System.String,System.Object[])
M:Microsoft.JSInterop.JSObjectReferenceExtensions.InvokeVoidAsync(Microsoft.JSInterop.IJSObjectReference,System.String,System.TimeSpan,System.Object[])
M:Microsoft.JSInterop.JSObjectReferenceExtensions.InvokeVoidAsync(Microsoft.JSInterop.IJSObjectReference,System.String,System.Threading.CancellationToken,System.Object[])
M:Microsoft.JSInterop.JSObjectReferenceExtensions.InvokeVoidAsync(Microsoft.JSInterop.IJSObjectReference,System.String,System.Object[])
T:Microsoft.JSInterop.JSObjectReferenceExtensions
M:Microsoft.JSInterop.JSRuntime.#ctor
M:Microsoft.JSInterop.JSRuntime.BeginInvokeJS(System.Int64,System.String,System.String)
M:Microsoft.JSInterop.JSRuntime.BeginInvokeJS(System.Int64,System.String,System.String,Microsoft.JSInterop.JSCallResultType,System.Int64)
P:Microsoft.JSInterop.JSRuntime.DefaultAsyncTimeout
M:Microsoft.JSInterop.JSRuntime.EndInvokeDotNet(Microsoft.JSInterop.Infrastructure.DotNetInvocationInfo,Microsoft.JSInterop.Infrastructure.DotNetInvocationResult@|System.Runtime.InteropServices.InAttribute)
M:Microsoft.JSInterop.JSRuntime.InvokeAsync``1(System.String,System.Object[])
M:Microsoft.JSInterop.JSRuntime.InvokeAsync``1(System.String,System.Threading.CancellationToken,System.Object[])
P:Microsoft.JSInterop.JSRuntime.JsonSerializerOptions
T:Microsoft.JSInterop.JSRuntime
M:Microsoft.JSInterop.JSRuntimeExtensions.InvokeAsync``1(Microsoft.JSInterop.IJSRuntime,System.String,System.Object[])
M:Microsoft.JSInterop.JSRuntimeExtensions.InvokeAsync``1(Microsoft.JSInterop.IJSRuntime,System.String,System.Threading.CancellationToken,System.Object[])
M:Microsoft.JSInterop.JSRuntimeExtensions.InvokeAsync``1(Microsoft.JSInterop.IJSRuntime,System.String,System.TimeSpan,System.Object[])
M:Microsoft.JSInterop.JSRuntimeExtensions.InvokeVoidAsync(Microsoft.JSInterop.IJSRuntime,System.String,System.Object[])
M:Microsoft.JSInterop.JSRuntimeExtensions.InvokeVoidAsync(Microsoft.JSInterop.IJSRuntime,System.String,System.Threading.CancellationToken,System.Object[])
M:Microsoft.JSInterop.JSRuntimeExtensions.InvokeVoidAsync(Microsoft.JSInterop.IJSRuntime,System.String,System.TimeSpan,System.Object[])
T:Microsoft.JSInterop.JSRuntimeExtensions
N:Microsoft.JSInterop.Implementation
M:Microsoft.JSInterop.Implementation.JSInProcessObjectReference.#ctor(Microsoft.JSInterop.JSInProcessRuntime,System.Int64)
M:Microsoft.JSInterop.Implementation.JSInProcessObjectReference.Dispose
M:Microsoft.JSInterop.Implementation.JSInProcessObjectReference.Invoke``1(System.String,System.Object[])
T:Microsoft.JSInterop.Implementation.JSInProcessObjectReference
M:Microsoft.JSInterop.Implementation.JSObjectReference.#ctor(Microsoft.JSInterop.JSRuntime,System.Int64)
M:Microsoft.JSInterop.Implementation.JSObjectReference.DisposeAsync
P:Microsoft.JSInterop.Implementation.JSObjectReference.Id
M:Microsoft.JSInterop.Implementation.JSObjectReference.InvokeAsync``1(System.String,System.Object[])
M:Microsoft.JSInterop.Implementation.JSObjectReference.InvokeAsync``1(System.String,System.Threading.CancellationToken,System.Object[])
T:Microsoft.JSInterop.Implementation.JSObjectReference
M:Microsoft.JSInterop.Implementation.JSObjectReference.ThrowIfDisposed
T:Microsoft.JSInterop.Implementation.JSObjectReferenceJsonWorker
M:Microsoft.JSInterop.Implementation.JSObjectReferenceJsonWorker.ReadJSObjectReferenceIdentifier(System.Text.Json.Utf8JsonReader@)
M:Microsoft.JSInterop.Implementation.JSObjectReferenceJsonWorker.WriteJSObjectReference(System.Text.Json.Utf8JsonWriter,Microsoft.JSInterop.Implementation.JSObjectReference)
N:Microsoft.JSInterop.Infrastructure
M:Microsoft.JSInterop.Infrastructure.DotNetDispatcher.BeginInvokeDotNet(Microsoft.JSInterop.JSRuntime,Microsoft.JSInterop.Infrastructure.DotNetInvocationInfo,System.String)
T:Microsoft.JSInterop.Infrastructure.DotNetDispatcher
M:Microsoft.JSInterop.Infrastructure.DotNetDispatcher.EndInvokeJS(Microsoft.JSInterop.JSRuntime,System.String)
M:Microsoft.JSInterop.Infrastructure.DotNetDispatcher.Invoke(Microsoft.JSInterop.JSRuntime,Microsoft.JSInterop.Infrastructure.DotNetInvocationInfo@,System.String)
M:Microsoft.JSInterop.Infrastructure.DotNetInvocationInfo.#ctor(System.String,System.String,System.Int64,System.String)
P:Microsoft.JSInterop.Infrastructure.DotNetInvocationInfo.AssemblyName
P:Microsoft.JSInterop.Infrastructure.DotNetInvocationInfo.CallId
T:Microsoft.JSInterop.Infrastructure.DotNetInvocationInfo
P:Microsoft.JSInterop.Infrastructure.DotNetInvocationInfo.DotNetObjectId
P:Microsoft.JSInterop.Infrastructure.DotNetInvocationInfo.MethodIdentifier
M:Microsoft.JSInterop.Infrastructure.DotNetInvocationResult.#ctor(System.Object)
M:Microsoft.JSInterop.Infrastructure.DotNetInvocationResult.#ctor(System.Exception,System.String)
T:Microsoft.JSInterop.Infrastructure.DotNetInvocationResult
P:Microsoft.JSInterop.Infrastructure.DotNetInvocationResult.ErrorKind
P:Microsoft.JSInterop.Infrastructure.DotNetInvocationResult.Exception
P:Microsoft.JSInterop.Infrastructure.DotNetInvocationResult.Result
P:Microsoft.JSInterop.Infrastructure.DotNetInvocationResult.Success

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions