File: JSInvokableAttribute.cs
Web Access
Project: src\src\JSInterop\Microsoft.JSInterop\src\Microsoft.JSInterop.csproj (Microsoft.JSInterop)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
namespace Microsoft.JSInterop;
 
/// <summary>
/// Identifies a .NET method as allowing invocation from JavaScript code.
/// Any method marked with this attribute may receive arbitrary parameter values
/// from untrusted callers. All inputs should be validated carefully.
/// </summary>
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public sealed class JSInvokableAttribute : Attribute
{
    /// <summary>
    /// Gets the identifier for the method. The identifier must be unique within the scope
    /// of an assembly.
    ///
    /// If not set, the identifier is taken from the name of the method. In this case the
    /// method name must be unique within the assembly.
    /// </summary>
    public string? Identifier { get; }
 
    /// <summary>
    /// Constructs an instance of <see cref="JSInvokableAttribute"/> without setting
    /// an identifier for the method.
    /// </summary>
    public JSInvokableAttribute()
    {
    }
 
    /// <summary>
    /// Constructs an instance of <see cref="JSInvokableAttribute"/> using the specified
    /// identifier.
    /// </summary>
    /// <param name="identifier">An identifier for the method, which must be unique within the scope of the assembly.</param>
    public JSInvokableAttribute(string identifier)
    {
        ArgumentException.ThrowIfNullOrEmpty(identifier);
 
        Identifier = identifier;
    }
}