Tingle.Extensions.PhoneValidators
5.0.0
dotnet add package Tingle.Extensions.PhoneValidators --version 5.0.0
NuGet\Install-Package Tingle.Extensions.PhoneValidators -Version 5.0.0
<PackageReference Include="Tingle.Extensions.PhoneValidators" Version="5.0.0" />
paket add Tingle.Extensions.PhoneValidators --version 5.0.0
#r "nuget: Tingle.Extensions.PhoneValidators, 5.0.0"
// Install Tingle.Extensions.PhoneValidators as a Cake Addin #addin nuget:?package=Tingle.Extensions.PhoneValidators&version=5.0.0 // Install Tingle.Extensions.PhoneValidators as a Cake Tool #tool nuget:?package=Tingle.Extensions.PhoneValidators&version=5.0.0
Tingle.Extensions.PhoneValidators
This library is used to validate if a phone number is valid. It can also be used to convert Kenyan phone numbers between E.164, local, and MSISDN formats.
Using attributes
The .NET framework has validation inbuilt by decorating attributes on your members. This library supports that workflow.
public class SetPhoneNumberModel
{
[Required]
public string UserId { get; set; }
[Required]
[E164Phone] // ensures value is in E.164 format
public string Primary { get; set; }
[E164Phone] // ensures all values are in E.164 format
[DataType(DataType.PhoneNumber)] // useful for generating docs in OpenAPI
public IList<string> Alternatives { get; set; }
}
Using this in AspNetCore is easy since model validation is inbuilt and enabled by default.
[Route("api/v1/[controller]")]
public class DummyController : ControllerBase
{
[HttpGet]
public Task<IActionResult> TestAsync([FromBody, Required] SetPhoneNumberModel model)
{
// If we get here, the model was already validated
// Otherwise, problem details were returned.
return Ok();
}
}
The available attributes include: |Attribute Name|Description| |--|--| |E164PhoneAttribute|Validates that the value is formatted as per the E.164 standard.| |MsisdnPhoneAttribute|Validates that the value is formatted as per the MSISDN format.| |SafaricomPhoneAttribute|Validates that the value is valid for Safaricom Kenya phone numbers| |AirtelPhoneAttribute|Validates that the value is valid for Airtel Kenya phone numbers| |TelkomPhoneAttribute|Validates that the value is valid for Telkom Kenya phone numbers|
Using Dependency Injection
First add to the services collection before they can be resolved.
Sample Usage (Safaricom validator)
[Route("api/v1/[controller]")]
public class DummyController : ControllerBase
{
private static readonly SafaricomPhoneNumberValidator phoneNumberValidator = new();
[HttpGet]
public Task<IActionResult> TestAsync([FromQuery] string phoneNumber)
{
var result = phoneNumberValidator.IsValid(phoneNumber);
if (!result) return BadRequest("Invalid Phone number!");
// Convert to MSISDN format
var msisdn = phoneNumberValidators.ToMsisdn(phoneNumber);
return Ok(msisdn);
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. |
.NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.1 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.1
- libphonenumber-csharp (>= 8.13.50)
- System.ComponentModel.Annotations (>= 5.0.0)
-
net8.0
- libphonenumber-csharp (>= 8.13.50)
-
net9.0
- libphonenumber-csharp (>= 8.13.50)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
5.0.0 | 111 | 11/19/2024 |
4.14.1 | 243 | 10/14/2024 |
4.14.0 | 324 | 9/16/2024 |
4.13.0 | 511 | 8/13/2024 |
4.12.0 | 176 | 8/7/2024 |
4.11.2 | 283 | 7/15/2024 |
4.11.1 | 333 | 6/26/2024 |
4.11.0 | 277 | 6/6/2024 |
4.10.1 | 117 | 6/5/2024 |
4.10.0 | 186 | 5/27/2024 |
4.9.0 | 270 | 5/16/2024 |
4.8.0 | 307 | 5/5/2024 |
4.7.0 | 430 | 3/25/2024 |
4.6.0 | 351 | 3/8/2024 |
4.5.0 | 1,537 | 11/22/2023 |
4.4.1 | 232 | 11/20/2023 |
4.4.0 | 244 | 11/15/2023 |
4.3.0 | 505 | 10/18/2023 |
4.2.2 | 601 | 9/20/2023 |
4.2.1 | 836 | 8/4/2023 |
4.2.0 | 1,149 | 5/31/2023 |
4.1.1 | 284 | 5/26/2023 |
4.1.0 | 302 | 5/22/2023 |
4.0.0 | 1,177 | 3/14/2023 |
3.8.1 | 1,416 | 11/30/2022 |
3.8.0 | 515 | 11/21/2022 |
3.7.0 | 2,235 | 9/4/2022 |
3.6.0 | 1,961 | 7/4/2022 |
3.5.3 | 2,516 | 4/8/2022 |
3.5.2 | 1,926 | 1/7/2022 |
3.5.1 | 1,871 | 11/11/2021 |
3.5.0 | 492 | 11/10/2021 |
3.4.7 | 1,051 | 11/2/2021 |
3.4.6 | 618 | 10/29/2021 |
3.4.5 | 1,236 | 10/9/2021 |
3.4.4 | 1,505 | 8/9/2021 |
3.4.3 | 334 | 8/9/2021 |
3.4.2 | 1,696 | 5/26/2021 |
0.1.0-ci0015 | 217 | 5/26/2021 |