# Security Card

## 🐈‍⬛ Canvafy Design;

<figure><img src="https://1203280867-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQ8KI56rkXEQp2Ao9aeTJ%2Fuploads%2F9SZSxk92RJRUxIijuMme%2Fsecurity.png?alt=media&#x26;token=f6e23db0-c361-4ff6-b230-42ebe2abb58f" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1203280867-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQ8KI56rkXEQp2Ao9aeTJ%2Fuploads%2FLEDFqyizynG42DWl96DH%2Fsecurity.png?alt=media&#x26;token=953025ce-91aa-4b82-9ac0-a9ab86e2127c" alt=""><figcaption></figcaption></figure>

```javascript
await new canvafy.Security()
```

## [.setAvatar(imageURL)](#.setavatar-imageurl)

| PARAMETER                                     | TYPE                                       | DESCRIPTION             |
| --------------------------------------------- | ------------------------------------------ | ----------------------- |
| <mark style="color:blue;">**imageURL**</mark> | <mark style="color:red;">**String**</mark> | **Setting User Avatar** |

## [.setBackground(type,source)](#.setbackground-image-imageurl)

| PARAMETER                                   | TYPE                                       | DESCRIPTION                             |
| ------------------------------------------- | ------------------------------------------ | --------------------------------------- |
| <mark style="color:blue;">**type**</mark>   | <mark style="color:red;">**String**</mark> | **"image" or "color" adjustment**       |
| <mark style="color:blue;">**source**</mark> | <mark style="color:red;">**String**</mark> | **"imageURL" or "hexColor" adjustment** |

## [.setLocale(locale)](#.settitle-name)

| PARAMETER                                   | TYPE                                       | DESCRIPTION                                                                                                                                                                                                                                       |
| ------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <mark style="color:blue;">**locale**</mark> | <mark style="color:red;">**String**</mark> | <p><strong>Country Short Code</strong><br><mark style="background-color:purple;"><strong>(Example; "en","fr","tr" etc.)</strong></mark><br><mark style="background-color:purple;"><strong>(</strong>Preferred Option<strong>)</strong></mark></p> |

## [.setCreatedTimestamp(date)](#.setcreatedtimestamp-date)

| PARAMETER                                 | TYPE                                          | DESCRIPTION                       |
| ----------------------------------------- | --------------------------------------------- | --------------------------------- |
| <mark style="color:blue;">**date**</mark> | <mark style="color:yellow;">**Number**</mark> | **Someone User CreatedTimestamp** |

## [.setSuspectTimestamp(date)](#.setsuspecttimestamp-date)

| PARAMETER                                 | TYPE                                          | DESCRIPTION                                 |
| ----------------------------------------- | --------------------------------------------- | ------------------------------------------- |
| <mark style="color:blue;">**date**</mark> | <mark style="color:yellow;">**Number**</mark> | **Period of Time to be Considered Suspect** |

## [.setBorder(color)](#.setborder-color)

| PARAMETER                                  | TYPE                                       | DESCRIPTION                                                                                                                                         |
| ------------------------------------------ | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| <mark style="color:blue;">**color**</mark> | <mark style="color:red;">**String**</mark> | <p><strong>"hexColor" adjustment</strong><br><mark style="background-color:purple;"><strong>(</strong>Preferred Option<strong>)</strong></mark></p> |

## [.se](#.setlevel-level)[tAvatarBorder(color)](#.setavatarborder-color)

| PARAMETER                                  | TYPE                                       | DESCRIPTION               |
| ------------------------------------------ | ------------------------------------------ | ------------------------- |
| <mark style="color:blue;">**color**</mark> | <mark style="color:red;">**String**</mark> | **"hexColor" adjustment** |

## [.setOverlayOpacity(opac)](#.setoverlayopacity-opac)

| PARAMETER                                 | TYPE                                                   | DESCRIPTION             |
| ----------------------------------------- | ------------------------------------------------------ | ----------------------- |
| <mark style="color:blue;">**opac**</mark> | <mark style="color:yellow;">**Number / Double**</mark> | **Transparent Opacity** |

## [.build()](#.build)

| PARAMETER                                       | TYPE                                            | DESCRIPTION                                                                                                            |
| ----------------------------------------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| ~~<mark style="color:purple;">**None**</mark>~~ | ~~<mark style="color:purple;">**None**</mark>~~ | <p><strong>Image Maker.</strong><br><em><mark style="color:orange;"><strong>❗Required to Use!</strong></mark></em></p> |

### **🌙 Example Of Code With Discord.js v14** <a href="#usage" id="usage"></a>

```javascript
client.on('guildMemberAdd', async member => {
  const security = await new canvafy.Security()
    .setAvatar(member.user.displayAvatarURL({extension:"png",forceStatic:true}))
    .setBackground("image", "https://cdn.discordapp.com/attachments/1087030211813593190/1110243947311288530/beeautiful-sunset-illustration-1212023.webp")
    .setCreatedTimestamp(member.user.createdTimestamp)
    .setSuspectTimestamp(604800000) // 1 week millisecond
    .setBorder("#f0f0f0")
    .setLocale("en") // country short code - default "en"
    .setAvatarBorder("#f0f0f0")
    .setOverlayOpacity(0.9)
    .build();

  member.guild.channels.cache.get("<channelId>").send({
    content: `Welcome ${member}!`,
    files: [{
      attachment: security,
      name: `security-${member.id}.png`
    }]
  });
});
```

## 📃Support Server; [discord.gg/luppux](https://discord.gg/luppux)
